pulp_container_client 2.14.16 → 2.15.0

data/docs/DistributionsApi.md

@@ -1,94 +0,0 @@
-# PulpContainerClient::DistributionsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**distributions_list**](DistributionsApi.md#distributions_list) | **GET** /pulp/api/v3/distributions/ | List distributions
-
-
-
-## distributions_list
-
-> PaginatedDistributionResponseList distributions_list(opts)
-
-List distributions
-
-Provides base viewset for Distributions.
-
-### 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::DistributionsApi.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__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
-  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_label_select: 'pulp_label_select_example', # String | Filter labels by search string
-  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 distributions
-  result = api_instance.distributions_list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling DistributionsApi->distributions_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__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [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 | [optional] 
- **pulp_label_select** | **String**| Filter labels by search string | [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
-
-[**PaginatedDistributionResponseList**](PaginatedDistributionResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/DistributionsArtifactsApi.md

@@ -1,154 +0,0 @@
-# PulpContainerClient::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_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::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__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
-  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_label_select: 'pulp_label_select_example', # String | Filter labels by search string
-  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 PulpContainerClient::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__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [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 | [optional] 
- **pulp_label_select** | **String**| Filter labels by search string | [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_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::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 PulpContainerClient::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 @@
-# PulpContainerClient::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_container_client'
-
-api_instance = PulpContainerClient::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 PulpContainerClient::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 @@
-# PulpContainerClient::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_container_client'
-
-api_instance = PulpContainerClient::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 PulpContainerClient::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/EvaluationResponse.md

@@ -1,21 +0,0 @@
-# PulpContainerClient::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 'PulpContainerClient'
-
-instance = PulpContainerClient::EvaluationResponse.new(context: null,
-                                 is_valid: null,
-                                 messages: null)
-```
-
-