pulpcore_client 3.22.22 → 3.23.0

data/docs/UpstreamPulpsApi.md

@@ -0,0 +1,405 @@
+# PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UpstreamPulpsApi.new
+upstream_pulp = PulpcoreClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Create an upstream pulp
+  result = api_instance.create(upstream_pulp)
+  p result
+rescue PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+
+begin
+  #Delete an upstream pulp
+  api_instance.delete(upstream_pulp_href)
+rescue PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::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 PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+patched_upstream_pulp = PulpcoreClient::PatchedUpstreamPulp.new # PatchedUpstreamPulp | 
+
+begin
+  #Update an upstream pulp
+  result = api_instance.partial_update(upstream_pulp_href, patched_upstream_pulp)
+  p result
+rescue PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::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 PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+upstream_pulp = PulpcoreClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Replicate
+  result = api_instance.replicate(upstream_pulp_href, upstream_pulp)
+  p result
+rescue PulpcoreClient::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 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UpstreamPulpsApi.new
+upstream_pulp_href = 'upstream_pulp_href_example' # String | 
+upstream_pulp = PulpcoreClient::UpstreamPulp.new # UpstreamPulp | 
+
+begin
+  #Update an upstream pulp
+  result = api_instance.update(upstream_pulp_href, upstream_pulp)
+  p result
+rescue PulpcoreClient::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
+

data/docs/UserRole.md

@@ -5,7 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **role** | **String** |  | 
-**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level. | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level. | 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
 
 ## Code Sample
 
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
 require 'PulpcoreClient'
 
 instance = PulpcoreClient::UserRole.new(role: null,
-                                 content_object: null)
+                                 content_object: null,
+                                 domain: null)
 ```
 
 

data/docs/UserRoleResponse.md

@@ -7,9 +7,10 @@ Name | Type | Description | Notes
 **pulp_href** | **String** |  | [optional] [readonly] 
 **pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
 **role** | **String** |  | 
-**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on the model-level. | 
+**content_object** | **String** | pulp_href of the object for which role permissions should be asserted. If set to 'null', permissions will act on either domain or model-level. | 
 **description** | **String** |  | [optional] [readonly] 
 **permissions** | **Array<String>** |  | [optional] [readonly] 
+**domain** | **String** | Domain this role should be applied on, mutually exclusive with content_object. | [optional] 
 
 ## Code Sample
 
@@ -21,7 +22,8 @@ instance = PulpcoreClient::UserRoleResponse.new(pulp_href: null,
                                  role: null,
                                  content_object: null,
                                  description: null,
-                                 permissions: null)
+                                 permissions: null,
+                                 domain: null)
 ```
 
 

data/docs/UsersApi.md

@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 Create an user
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 Delete an user
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 
@@ -124,7 +124,7 @@ nil (empty response body)
 
 List users
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 
@@ -231,7 +231,7 @@ Name | Type | Description  | Notes
 
 Update an user
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 
@@ -286,7 +286,7 @@ Name | Type | Description  | Notes
 
 Inspect an user
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 
@@ -345,7 +345,7 @@ Name | Type | Description  | Notes
 
 Update an user
 
-ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for User.
 
 ### Example
 

data/docs/UsersRolesApi.md

@@ -17,7 +17,7 @@ Method | HTTP request | Description
 
 Create an user role
 
-ViewSet for UserRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for UserRole.
 
 ### Example
 
@@ -72,7 +72,7 @@ Name | Type | Description  | Notes
 
 Delete an user role
 
-ViewSet for UserRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for UserRole.
 
 ### Example
 
@@ -124,7 +124,7 @@ nil (empty response body)
 
 List user roles
 
-ViewSet for UserRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for UserRole.
 
 ### Example
 
@@ -142,6 +142,7 @@ api_instance = PulpcoreClient::UsersRolesApi.new
 auth_user_href = 'auth_user_href_example' # String | 
 opts = {
   content_object: 'content_object_example', # String | content_object
+  domain: 'domain_example', # String | Foreign Key referenced by HREF
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
   ordering: ['ordering_example'], # Array<String> | Ordering
@@ -170,6 +171,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **auth_user_href** | **String**|  | 
  **content_object** | **String**| content_object | [optional] 
+ **domain** | **String**| Foreign Key referenced by HREF | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
  **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
@@ -201,7 +203,7 @@ Name | Type | Description  | Notes
 
 Inspect an user role
 
-ViewSet for UserRole.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+ViewSet for UserRole.
 
 ### Example
 

data/docs/VersionResponse.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **component** | **String** | Name of a versioned component of Pulp | 
 **version** | **String** | Version of the component (e.g. 3.0.0) | 
 **package** | **String** | Python package name providing the component | 
+**domain_compatible** | **Boolean** | Domain feature compatibility of component | 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'PulpcoreClient'
 
 instance = PulpcoreClient::VersionResponse.new(component: null,
                                  version: null,
-                                 package: null)
+                                 package: null,
+                                 domain_compatible: null)
 ```
 
 

data/lib/pulpcore_client/api/distributions_api.rb

@@ -35,6 +35,8 @@ module PulpcoreClient
     # @option opts [Integer] :offset The initial index from which to return the results.
     # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :repository Filter results where repository matches value
+    # @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values
     # @option opts [String] :with_content Filter distributions based on the content served by them
     # @option opts [Array<String>] :fields A list of fields to include in the response.
     # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
@@ -60,6 +62,8 @@ module PulpcoreClient
     # @option opts [Integer] :offset The initial index from which to return the results.
     # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :repository Filter results where repository matches value
+    # @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values
     # @option opts [String] :with_content Filter distributions based on the content served by them
     # @option opts [Array<String>] :fields A list of fields to include in the response.
     # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
@@ -90,6 +94,8 @@ module PulpcoreClient
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
       query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
+      query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
+      query_params[:'repository__in'] = @api_client.build_collection_param(opts[:'repository__in'], :csv) if !opts[:'repository__in'].nil?
       query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
       query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
       query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?

data/lib/pulpcore_client/api/distributions_artifacts_api.rb

@@ -35,6 +35,8 @@ module PulpcoreClient
     # @option opts [Integer] :offset The initial index from which to return the results.
     # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :repository Filter results where repository matches value
+    # @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values
     # @option opts [String] :with_content Filter distributions based on the content served by them
     # @option opts [Array<String>] :fields A list of fields to include in the response.
     # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
@@ -60,6 +62,8 @@ module PulpcoreClient
     # @option opts [Integer] :offset The initial index from which to return the results.
     # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :repository Filter results where repository matches value
+    # @option opts [Array<String>] :repository__in Filter results where repository is in a comma-separated list of values
     # @option opts [String] :with_content Filter distributions based on the content served by them
     # @option opts [Array<String>] :fields A list of fields to include in the response.
     # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
@@ -90,6 +94,8 @@ module PulpcoreClient
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
       query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
+      query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil?
+      query_params[:'repository__in'] = @api_client.build_collection_param(opts[:'repository__in'], :csv) if !opts[:'repository__in'].nil?
       query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].nil?
       query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
       query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil?