pulp_file_client 3.55.2 → 3.55.3

data/docs/DomainsApi.md

@@ -1,376 +0,0 @@
-# PulpFileClient::DomainsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**domains_create**](DomainsApi.md#domains_create) | **POST** /pulp/api/v3/domains/ | Create a domain
-[**domains_delete**](DomainsApi.md#domains_delete) | **DELETE** {domain_href} | Delete a domain
-[**domains_list**](DomainsApi.md#domains_list) | **GET** /pulp/api/v3/domains/ | List domains
-[**domains_partial_update**](DomainsApi.md#domains_partial_update) | **PATCH** {domain_href} | Update a domain
-[**domains_read**](DomainsApi.md#domains_read) | **GET** {domain_href} | Inspect a domain
-[**domains_update**](DomainsApi.md#domains_update) | **PUT** {domain_href} | Update a domain
-
-
-
-## domains_create
-
-> DomainResponse domains_create(domain)
-
-Create a domain
-
-ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::DomainsApi.new
-domain = PulpFileClient::Domain.new # Domain | 
-
-begin
-  #Create a domain
-  result = api_instance.domains_create(domain)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain** | [**Domain**](Domain.md)|  | 
-
-### Return type
-
-[**DomainResponse**](DomainResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## domains_delete
-
-> AsyncOperationResponse domains_delete(domain_href)
-
-Delete a domain
-
-Trigger an asynchronous delete task
-
-### 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::DomainsApi.new
-domain_href = 'domain_href_example' # String | 
-
-begin
-  #Delete a domain
-  result = api_instance.domains_delete(domain_href)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain_href** | **String**|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## domains_list
-
-> PaginatedDomainResponseList domains_list(opts)
-
-List domains
-
-ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::DomainsApi.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) * `name` - Name * `-name` - Name (descending) * `description` - Description * `-description` - Description (descending) * `storage_class` - Storage class * `-storage_class` - Storage class (descending) * `storage_settings` - Storage settings * `-storage_settings` - Storage settings (descending) * `redirect_to_object_storage` - Redirect to object storage * `-redirect_to_object_storage` - Redirect to object storage (descending) * `hide_guarded_distributions` - Hide guarded distributions * `-hide_guarded_distributions` - Hide guarded distributions (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 domains
-  result = api_instance.domains_list(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;storage_class&#x60; - Storage class * &#x60;-storage_class&#x60; - Storage class (descending) * &#x60;storage_settings&#x60; - Storage settings * &#x60;-storage_settings&#x60; - Storage settings (descending) * &#x60;redirect_to_object_storage&#x60; - Redirect to object storage * &#x60;-redirect_to_object_storage&#x60; - Redirect to object storage (descending) * &#x60;hide_guarded_distributions&#x60; - Hide guarded distributions * &#x60;-hide_guarded_distributions&#x60; - Hide guarded distributions (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
-
-[**PaginatedDomainResponseList**](PaginatedDomainResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## domains_partial_update
-
-> AsyncOperationResponse domains_partial_update(domain_href, patched_domain)
-
-Update a domain
-
-Trigger an asynchronous partial update task
-
-### 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::DomainsApi.new
-domain_href = 'domain_href_example' # String | 
-patched_domain = PulpFileClient::PatchedDomain.new # PatchedDomain | 
-
-begin
-  #Update a domain
-  result = api_instance.domains_partial_update(domain_href, patched_domain)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain_href** | **String**|  | 
- **patched_domain** | [**PatchedDomain**](PatchedDomain.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## domains_read
-
-> DomainResponse domains_read(domain_href, opts)
-
-Inspect a domain
-
-ViewSet for Domain.  NOTE: This API endpoint is in \"tech preview\" and subject to change
-
-### 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::DomainsApi.new
-domain_href = 'domain_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 domain
-  result = api_instance.domains_read(domain_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain_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
-
-[**DomainResponse**](DomainResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## domains_update
-
-> AsyncOperationResponse domains_update(domain_href, domain)
-
-Update a domain
-
-Trigger an asynchronous update task
-
-### 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::DomainsApi.new
-domain_href = 'domain_href_example' # String | 
-domain = PulpFileClient::Domain.new # Domain | 
-
-begin
-  #Update a domain
-  result = api_instance.domains_update(domain_href, domain)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DomainsApi->domains_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **domain_href** | **String**|  | 
- **domain** | [**Domain**](Domain.md)|  | 
-
-### Return type
-
-[**AsyncOperationResponse**](AsyncOperationResponse.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/EvaluationResponse.md

@@ -1,21 +0,0 @@
-# PulpFileClient::EvaluationResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**context** | **String** | Parameter value being evaluated. | 
-**is_valid** | **Boolean** | True if evaluation passed, false otherwise. | 
-**messages** | **Array<String>** | Messages describing results of all evaluations done. May be an empty list. | 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::EvaluationResponse.new(context: null,
-                                 is_valid: null,
-                                 messages: null)
-```
-
-