pulp_file_client 3.49.14 → 3.49.15

data/docs/UpstreamPulpResponse.md

@@ -1,39 +0,0 @@
-# PulpFileClient::UpstreamPulpResponse
-
-## 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 most recent update of the remote. | [optional] [readonly] 
-**name** | **String** | A unique name for this Pulp server. | 
-**base_url** | **String** | The transport, hostname, and an optional port of the Pulp server. e.g. https://example.com | 
-**api_root** | **String** | The API root. Defaults to '/pulp/'. | 
-**domain** | **String** | The domain of the Pulp server if enabled. | [optional] 
-**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
-**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
-**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**hidden_fields** | [**Array<RemoteResponseHiddenFields>**](RemoteResponseHiddenFields.md) | List of hidden (write only) fields | [optional] [readonly] 
-**pulp_label_select** | **String** | One or more comma separated labels that will be used to filter distributions on the upstream Pulp. E.g. \"foo=bar,key=val\" or \"foo,key\" | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::UpstreamPulpResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 base_url: null,
-                                 api_root: null,
-                                 domain: null,
-                                 ca_cert: null,
-                                 client_cert: null,
-                                 tls_validation: null,
-                                 hidden_fields: null,
-                                 pulp_label_select: null)
-```
-
-

data/docs/UpstreamPulpsApi.md

@@ -1,635 +0,0 @@
-# PulpFileClient::UpstreamPulpsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**upstream_pulps_add_role**](UpstreamPulpsApi.md#upstream_pulps_add_role) | **POST** {upstream_pulp_href}add_role/ | Add a role
-[**upstream_pulps_create**](UpstreamPulpsApi.md#upstream_pulps_create) | **POST** /pulp/api/v3/upstream-pulps/ | Create an upstream pulp
-[**upstream_pulps_delete**](UpstreamPulpsApi.md#upstream_pulps_delete) | **DELETE** {upstream_pulp_href} | Delete an upstream pulp
-[**upstream_pulps_list**](UpstreamPulpsApi.md#upstream_pulps_list) | **GET** /pulp/api/v3/upstream-pulps/ | List upstream pulps
-[**upstream_pulps_list_roles**](UpstreamPulpsApi.md#upstream_pulps_list_roles) | **GET** {upstream_pulp_href}list_roles/ | List roles
-[**upstream_pulps_my_permissions**](UpstreamPulpsApi.md#upstream_pulps_my_permissions) | **GET** {upstream_pulp_href}my_permissions/ | List user permissions
-[**upstream_pulps_partial_update**](UpstreamPulpsApi.md#upstream_pulps_partial_update) | **PATCH** {upstream_pulp_href} | Update an upstream pulp
-[**upstream_pulps_read**](UpstreamPulpsApi.md#upstream_pulps_read) | **GET** {upstream_pulp_href} | Inspect an upstream pulp
-[**upstream_pulps_remove_role**](UpstreamPulpsApi.md#upstream_pulps_remove_role) | **POST** {upstream_pulp_href}remove_role/ | Remove a role
-[**upstream_pulps_replicate**](UpstreamPulpsApi.md#upstream_pulps_replicate) | **POST** {upstream_pulp_href}replicate/ | Replicate
-[**upstream_pulps_update**](UpstreamPulpsApi.md#upstream_pulps_update) | **PUT** {upstream_pulp_href} | Update an upstream pulp
-
-
-
-## upstream_pulps_add_role
-
-> NestedRoleResponse upstream_pulps_add_role(upstream_pulp_href, nested_role)
-
-Add a role
-
-Add a role for this object to users/groups.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-nested_role = PulpFileClient::NestedRole.new # NestedRole | 
-
-begin
-  #Add a role
-  result = api_instance.upstream_pulps_add_role(upstream_pulp_href, nested_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_add_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
-
-### Return type
-
-[**NestedRoleResponse**](NestedRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## upstream_pulps_create
-
-> UpstreamPulpResponse upstream_pulps_create(upstream_pulp)
-
-Create an upstream pulp
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp = PulpFileClient::UpstreamPulp.new # UpstreamPulp | 
-
-begin
-  #Create an upstream pulp
-  result = api_instance.upstream_pulps_create(upstream_pulp)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.md)|  | 
-
-### Return type
-
-[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## upstream_pulps_delete
-
-> upstream_pulps_delete(upstream_pulp_href)
-
-Delete an upstream pulp
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-
-begin
-  #Delete an upstream pulp
-  api_instance.upstream_pulps_delete(upstream_pulp_href)
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## upstream_pulps_list
-
-> PaginatedUpstreamPulpResponseList upstream_pulps_list(opts)
-
-List upstream pulps
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-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 upstream pulps
-  result = api_instance.upstream_pulps_list(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **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
-
-[**PaginatedUpstreamPulpResponseList**](PaginatedUpstreamPulpResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## upstream_pulps_list_roles
-
-> ObjectRolesResponse upstream_pulps_list_roles(upstream_pulp_href, opts)
-
-List roles
-
-List roles assigned to this object.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_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
-  #List roles
-  result = api_instance.upstream_pulps_list_roles(upstream_pulp_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_list_roles: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_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
-
-[**ObjectRolesResponse**](ObjectRolesResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## upstream_pulps_my_permissions
-
-> MyPermissionsResponse upstream_pulps_my_permissions(upstream_pulp_href, opts)
-
-List user permissions
-
-List permissions available to the current user on this object.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_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
-  #List user permissions
-  result = api_instance.upstream_pulps_my_permissions(upstream_pulp_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_my_permissions: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_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
-
-[**MyPermissionsResponse**](MyPermissionsResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## upstream_pulps_partial_update
-
-> UpstreamPulpResponse upstream_pulps_partial_update(upstream_pulp_href, patched_upstream_pulp)
-
-Update an upstream pulp
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-patched_upstream_pulp = PulpFileClient::PatchedUpstreamPulp.new # PatchedUpstreamPulp | 
-
-begin
-  #Update an upstream pulp
-  result = api_instance.upstream_pulps_partial_update(upstream_pulp_href, patched_upstream_pulp)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
- **patched_upstream_pulp** | [**PatchedUpstreamPulp**](PatchedUpstreamPulp.md)|  | 
-
-### Return type
-
-[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## upstream_pulps_read
-
-> UpstreamPulpResponse upstream_pulps_read(upstream_pulp_href, opts)
-
-Inspect an upstream pulp
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_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 upstream pulp
-  result = api_instance.upstream_pulps_read(upstream_pulp_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_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
-
-[**UpstreamPulpResponse**](UpstreamPulpResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## upstream_pulps_remove_role
-
-> NestedRoleResponse upstream_pulps_remove_role(upstream_pulp_href, nested_role)
-
-Remove a role
-
-Remove a role for this object from users/groups.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-nested_role = PulpFileClient::NestedRole.new # NestedRole | 
-
-begin
-  #Remove a role
-  result = api_instance.upstream_pulps_remove_role(upstream_pulp_href, nested_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_remove_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
- **nested_role** | [**NestedRole**](NestedRole.md)|  | 
-
-### Return type
-
-[**NestedRoleResponse**](NestedRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## upstream_pulps_replicate
-
-> TaskGroupOperationResponse upstream_pulps_replicate(upstream_pulp_href)
-
-Replicate
-
-Trigger an asynchronous repository replication task group. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-
-begin
-  #Replicate
-  result = api_instance.upstream_pulps_replicate(upstream_pulp_href)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_replicate: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
-
-### Return type
-
-[**TaskGroupOperationResponse**](TaskGroupOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## upstream_pulps_update
-
-> UpstreamPulpResponse upstream_pulps_update(upstream_pulp_href, upstream_pulp)
-
-Update an upstream pulp
-
-API for configuring an upstream Pulp to replicate. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-upstream_pulp = PulpFileClient::UpstreamPulp.new # UpstreamPulp | 
-
-begin
-  #Update an upstream pulp
-  result = api_instance.upstream_pulps_update(upstream_pulp_href, upstream_pulp)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->upstream_pulps_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
- **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.md)|  | 
-
-### Return type
-
-[**UpstreamPulpResponse**](UpstreamPulpResponse.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/User.md

@@ -1,29 +0,0 @@
-# PulpFileClient::User
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | 
-**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 'PulpFileClient'
-
-instance = PulpFileClient::User.new(username: null,
-                                 password: null,
-                                 first_name: null,
-                                 last_name: null,
-                                 email: null,
-                                 is_staff: null,
-                                 is_active: null)
-```
-
-