pulp_file_client 3.55.2 → 3.56.0

data/docs/DistributionsArtifactsApi.md

@@ -1,172 +0,0 @@
-# PulpFileClient::DistributionsArtifactsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**distributions_core_artifacts_list**](DistributionsArtifactsApi.md#distributions_core_artifacts_list) | **GET** /pulp/api/v3/distributions/core/artifacts/ | List artifact distributions
-[**distributions_core_artifacts_read**](DistributionsArtifactsApi.md#distributions_core_artifacts_read) | **GET** {artifact_distribution_href} | Inspect an artifact distribution
-
-
-
-## distributions_core_artifacts_list
-
-> PaginatedArtifactDistributionResponseList distributions_core_artifacts_list(opts)
-
-List artifact distributions
-
-ViewSet for ArtifactDistribution.
-
-### 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::DistributionsArtifactsApi.new
-opts = {
-  base_path: 'base_path_example', # String | Filter results where base_path matches value
-  base_path__contains: 'base_path__contains_example', # String | Filter results where base_path contains value
-  base_path__icontains: 'base_path__icontains_example', # String | Filter results where base_path contains value
-  base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values
-  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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (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.
-  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
-  q: 'q_example', # String | 
-  repository: 'repository_example', # String | Filter results where repository matches value
-  repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values
-  with_content: 'with_content_example', # String | Filter distributions based on the content served by them
-  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 artifact distributions
-  result = api_instance.distributions_core_artifacts_list(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsArtifactsApi->distributions_core_artifacts_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **base_path** | **String**| Filter results where base_path matches value | [optional] 
- **base_path__contains** | **String**| Filter results where base_path contains value | [optional] 
- **base_path__icontains** | **String**| Filter results where base_path contains value | [optional] 
- **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional] 
- **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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (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] 
- **pulp_label_select** | **String**| Filter labels by search string | [optional] 
- **q** | **String**|  | [optional] 
- **repository** | [**String**](.md)| Filter results where repository matches value | [optional] 
- **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional] 
- **with_content** | **String**| Filter distributions based on the content served by them | [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
-
-[**PaginatedArtifactDistributionResponseList**](PaginatedArtifactDistributionResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## distributions_core_artifacts_read
-
-> ArtifactDistributionResponse distributions_core_artifacts_read(artifact_distribution_href, opts)
-
-Inspect an artifact distribution
-
-ViewSet for ArtifactDistribution.
-
-### 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::DistributionsArtifactsApi.new
-artifact_distribution_href = 'artifact_distribution_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 artifact distribution
-  result = api_instance.distributions_core_artifacts_read(artifact_distribution_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DistributionsArtifactsApi->distributions_core_artifacts_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **artifact_distribution_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
-
-[**ArtifactDistributionResponse**](ArtifactDistributionResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/DocsApiJsonApi.md

@@ -1,61 +0,0 @@
-# PulpFileClient::DocsApiJsonApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**docs_api_json_get**](DocsApiJsonApi.md#docs_api_json_get) | **GET** /pulp/api/v3/docs/api.json | 
-
-
-
-## docs_api_json_get
-
-> Object docs_api_json_get(opts)
-
-
-
-OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-
-api_instance = PulpFileClient::DocsApiJsonApi.new
-opts = {
-  lang: 'lang_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
-  result = api_instance.docs_api_json_get(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DocsApiJsonApi->docs_api_json_get: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **lang** | **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
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/vnd.oai.openapi+json, application/json
-

data/docs/DocsApiYamlApi.md

@@ -1,61 +0,0 @@
-# PulpFileClient::DocsApiYamlApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**docs_api_yaml_get**](DocsApiYamlApi.md#docs_api_yaml_get) | **GET** /pulp/api/v3/docs/api.yaml | 
-
-
-
-## docs_api_yaml_get
-
-> Object docs_api_yaml_get(opts)
-
-
-
-OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_file_client'
-
-api_instance = PulpFileClient::DocsApiYamlApi.new
-opts = {
-  lang: 'lang_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
-  result = api_instance.docs_api_yaml_get(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling DocsApiYamlApi->docs_api_yaml_get: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **lang** | **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
-
-**Object**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/vnd.oai.openapi, application/yaml
-

data/docs/Domain.md

@@ -1,27 +0,0 @@
-# PulpFileClient::Domain
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A name for this domain. | 
-**description** | **String** | An optional description. | [optional] 
-**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | 
-**storage_settings** | [**Object**](.md) | Settings for storage class. | 
-**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
-**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::Domain.new(name: null,
-                                 description: null,
-                                 storage_class: null,
-                                 storage_settings: null,
-                                 redirect_to_object_storage: null,
-                                 hide_guarded_distributions: null)
-```
-
-

data/docs/DomainResponse.md

@@ -1,33 +0,0 @@
-# PulpFileClient::DomainResponse
-
-## 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** | A name for this domain. | 
-**description** | **String** | An optional description. | [optional] 
-**storage_class** | [**StorageClassEnum**](StorageClassEnum.md) | Backend storage class for domain.  * `pulpcore.app.models.storage.FileSystem` - Use local filesystem as storage * `storages.backends.s3boto3.S3Boto3Storage` - Use Amazon S3 as storage * `storages.backends.azure_storage.AzureStorage` - Use Azure Blob as storage | 
-**storage_settings** | [**Object**](.md) | Settings for storage class. | 
-**redirect_to_object_storage** | **Boolean** | Boolean to have the content app redirect to object storage. | [optional] [default to true]
-**hide_guarded_distributions** | **Boolean** | Boolean to hide distributions with a content guard in the content app. | [optional] [default to false]
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::DomainResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 description: null,
-                                 storage_class: null,
-                                 storage_settings: null,
-                                 redirect_to_object_storage: null,
-                                 hide_guarded_distributions: null)
-```
-
-