pulp_container_client 2.14.14 → 2.14.16

data/docs/UpstreamPulpsApi.md

@@ -1,405 +0,0 @@
-# PulpContainerClient::UpstreamPulpsApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](UpstreamPulpsApi.md#create) | **POST** /pulp/api/v3/upstream-pulps/ | Create an upstream pulp
-[**delete**](UpstreamPulpsApi.md#delete) | **DELETE** {upstream_pulp_href} | Delete an upstream pulp
-[**list**](UpstreamPulpsApi.md#list) | **GET** /pulp/api/v3/upstream-pulps/ | List upstream pulps
-[**partial_update**](UpstreamPulpsApi.md#partial_update) | **PATCH** {upstream_pulp_href} | Update an upstream pulp
-[**read**](UpstreamPulpsApi.md#read) | **GET** {upstream_pulp_href} | Inspect an upstream pulp
-[**replicate**](UpstreamPulpsApi.md#replicate) | **POST** {upstream_pulp_href}replicate/ | Replicate
-[**update**](UpstreamPulpsApi.md#update) | **PUT** {upstream_pulp_href} | Update an upstream pulp
-
-
-
-## create
-
-> UpstreamPulpResponse 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_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::UpstreamPulpsApi.new
-upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
-
-begin
-  #Create an upstream pulp
-  result = api_instance.create(upstream_pulp)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-
-
-## delete
-
-> 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_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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-
-begin
-  #Delete an upstream pulp
-  api_instance.delete(upstream_pulp_href)
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-
-
-## list
-
-> PaginatedUpstreamPulpResponseList 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_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::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.list(opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-
-
-## partial_update
-
-> UpstreamPulpResponse 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_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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-patched_upstream_pulp = PulpContainerClient::PatchedUpstreamPulp.new # PatchedUpstreamPulp | 
-
-begin
-  #Update an upstream pulp
-  result = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-
-
-## read
-
-> UpstreamPulpResponse 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_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::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.read(upstream_pulp_href, opts)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-
-
-## replicate
-
-> AsyncOperationResponse replicate(upstream_pulp_href, upstream_pulp)
-
-Replicate
-
-Trigger an asynchronous repository replication task group. This API is provided as a tech preview.
-
-### 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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
-
-begin
-  #Replicate
-  result = api_instance.replicate(upstream_pulp_href, upstream_pulp)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->replicate: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **upstream_pulp_href** | **String**|  | 
- **upstream_pulp** | [**UpstreamPulp**](UpstreamPulp.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
-
-
-## update
-
-> UpstreamPulpResponse 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_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::UpstreamPulpsApi.new
-upstream_pulp_href = 'upstream_pulp_href_example' # String | 
-upstream_pulp = PulpContainerClient::UpstreamPulp.new # UpstreamPulp | 
-
-begin
-  #Update an upstream pulp
-  result = api_instance.update(upstream_pulp_href, upstream_pulp)
-  p result
-rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling UpstreamPulpsApi->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
-