pulp_rpm_client 3.18.21 → 3.19.0.dev1675307375

data/docs/RolesApi.md

@@ -1,379 +0,0 @@
-# PulpRpmClient::RolesApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](RolesApi.md#create) | **POST** /pulp/api/v3/roles/ | Create a role
-[**delete**](RolesApi.md#delete) | **DELETE** {role_href} | Delete a role
-[**list**](RolesApi.md#list) | **GET** /pulp/api/v3/roles/ | List roles
-[**partial_update**](RolesApi.md#partial_update) | **PATCH** {role_href} | Update a role
-[**read**](RolesApi.md#read) | **GET** {role_href} | Inspect a role
-[**update**](RolesApi.md#update) | **PUT** {role_href} | Update a role
-
-
-
-## create
-
-> RoleResponse create(role)
-
-Create a role
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-role = PulpRpmClient::Role.new # Role | 
-
-begin
-  #Create a role
-  result = api_instance.create(role)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role** | [**Role**](Role.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.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(role_href)
-
-Delete a role
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-role_href = 'role_href_example' # String | 
-
-begin
-  #Delete a role
-  api_instance.delete(role_href)
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## list
-
-> PaginatedRoleResponseList list(opts)
-
-List roles
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-opts = {
-  contains_permission: ['contains_permission_example'], # Array<String> | Filter roles that have any of the permissions in the list.
-  description: 'description_example', # String | Filter results where description matches value
-  description__contains: 'description__contains_example', # String | Filter results where description contains value
-  description__icontains: 'description__icontains_example', # String | Filter results where description contains value
-  description__iexact: 'description__iexact_example', # String | Filter results where description matches value
-  for_object_type: 'for_object_type_example', # String | Filter roles that only have permissions for the specified object HREF.
-  limit: 56, # Integer | Number of results to return per page.
-  locked: true, # Boolean | Filter results where locked matches value
-  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_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) * `locked` - Locked * `-locked` - Locked (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.
-  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 roles
-  result = api_instance.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **contains_permission** | [**Array&lt;String&gt;**](String.md)| Filter roles that have any of the permissions in the list. | [optional] 
- **description** | **String**| Filter results where description matches value | [optional] 
- **description__contains** | **String**| Filter results where description contains value | [optional] 
- **description__icontains** | **String**| Filter results where description contains value | [optional] 
- **description__iexact** | **String**| Filter results where description matches value | [optional] 
- **for_object_type** | **String**| Filter roles that only have permissions for the specified object HREF. | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **locked** | **Boolean**| Filter results where locked matches value | [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  * &#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;locked&#x60; - Locked * &#x60;-locked&#x60; - Locked (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] 
- **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
-
-[**PaginatedRoleResponseList**](PaginatedRoleResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## partial_update
-
-> RoleResponse partial_update(role_href, patched_role)
-
-Update a role
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-role_href = 'role_href_example' # String | 
-patched_role = PulpRpmClient::PatchedRole.new # PatchedRole | 
-
-begin
-  #Update a role
-  result = api_instance.partial_update(role_href, patched_role)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
- **patched_role** | [**PatchedRole**](PatchedRole.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.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
-
-> RoleResponse read(role_href, opts)
-
-Inspect a role
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-role_href = 'role_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 role
-  result = api_instance.read(role_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_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
-
-[**RoleResponse**](RoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## update
-
-> RoleResponse update(role_href, role)
-
-Update a role
-
-ViewSet for Role.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::RolesApi.new
-role_href = 'role_href_example' # String | 
-role = PulpRpmClient::Role.new # Role | 
-
-begin
-  #Update a role
-  result = api_instance.update(role_href, role)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling RolesApi->update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **role_href** | **String**|  | 
- **role** | [**Role**](Role.md)|  | 
-
-### Return type
-
-[**RoleResponse**](RoleResponse.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/SigningServiceResponse.md

@@ -1,27 +0,0 @@
-# PulpRpmClient::SigningServiceResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**name** | **String** | A unique name used to recognize a script. | 
-**public_key** | **String** | The value of a public key used for the repository verification. | 
-**pubkey_fingerprint** | **String** | The fingerprint of the public key. | 
-**script** | **String** | An absolute path to a script which is going to be used for the signing. | 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::SigningServiceResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 name: null,
-                                 public_key: null,
-                                 pubkey_fingerprint: null,
-                                 script: null)
-```
-
-

data/docs/SigningServicesApi.md

@@ -1,138 +0,0 @@
-# PulpRpmClient::SigningServicesApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](SigningServicesApi.md#list) | **GET** /pulp/api/v3/signing-services/ | List signing services
-[**read**](SigningServicesApi.md#read) | **GET** {signing_service_href} | Inspect a signing service
-
-
-
-## list
-
-> PaginatedSigningServiceResponseList list(opts)
-
-List signing services
-
-A ViewSet that supports browsing of existing signing services.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::SigningServicesApi.new
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  name: 'name_example', # String | Filter results where name matches 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) * `public_key` - Public key * `-public_key` - Public key (descending) * `pubkey_fingerprint` - Pubkey fingerprint * `-pubkey_fingerprint` - Pubkey fingerprint (descending) * `script` - Script * `-script` - Script (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.
-  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 signing services
-  result = api_instance.list(opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling SigningServicesApi->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] 
- **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;public_key&#x60; - Public key * &#x60;-public_key&#x60; - Public key (descending) * &#x60;pubkey_fingerprint&#x60; - Pubkey fingerprint * &#x60;-pubkey_fingerprint&#x60; - Pubkey fingerprint (descending) * &#x60;script&#x60; - Script * &#x60;-script&#x60; - Script (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] 
- **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
-
-[**PaginatedSigningServiceResponseList**](PaginatedSigningServiceResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## read
-
-> SigningServiceResponse read(signing_service_href, opts)
-
-Inspect a signing service
-
-A ViewSet that supports browsing of existing signing services.
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-# setup authorization
-PulpRpmClient.configure do |config|
-  # Configure HTTP basic authorization: basicAuth
-  config.username = 'YOUR USERNAME'
-  config.password = 'YOUR PASSWORD'
-end
-
-api_instance = PulpRpmClient::SigningServicesApi.new
-signing_service_href = 'signing_service_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 signing service
-  result = api_instance.read(signing_service_href, opts)
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling SigningServicesApi->read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **signing_service_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
-
-[**SigningServiceResponse**](SigningServiceResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/StatesEnum.md

@@ -1,16 +0,0 @@
-# PulpRpmClient::StatesEnum
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::StatesEnum.new()
-```
-
-

data/docs/StatusApi.md

@@ -1,52 +0,0 @@
-# PulpRpmClient::StatusApi
-
-All URIs are relative to *https://pulp*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**status_read**](StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of Pulp
-
-
-
-## status_read
-
-> StatusResponse status_read
-
-Inspect status of Pulp
-
-Returns status and app information about Pulp.  Information includes:  * version of pulpcore and loaded pulp plugins  * known workers  * known content apps  * database connection status  * redis connection status  * disk usage information
-
-### Example
-
-```ruby
-# load the gem
-require 'pulp_rpm_client'
-
-api_instance = PulpRpmClient::StatusApi.new
-
-begin
-  #Inspect status of Pulp
-  result = api_instance.status_read
-  p result
-rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling StatusApi->status_read: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**StatusResponse**](StatusResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/StatusResponse.md

@@ -1,31 +0,0 @@
-# PulpRpmClient::StatusResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**versions** | [**Array<VersionResponse>**](VersionResponse.md) | Version information of Pulp components | 
-**online_workers** | [**Array<WorkerResponse>**](WorkerResponse.md) | List of online workers known to the application. An online worker is actively heartbeating and can respond to new work | 
-**online_content_apps** | [**Array<ContentAppStatusResponse>**](ContentAppStatusResponse.md) | List of online content apps known to the application. An online content app is actively heartbeating and can serve data to clients | 
-**database_connection** | [**DatabaseConnectionResponse**](DatabaseConnectionResponse.md) | Database connection information | 
-**redis_connection** | [**RedisConnectionResponse**](RedisConnectionResponse.md) | Redis connection information | [optional] 
-**storage** | [**StorageResponse**](StorageResponse.md) | Storage information | [optional] 
-**content_settings** | [**ContentSettingsResponse**](ContentSettingsResponse.md) | Content-app settings | 
-**domain_enabled** | **Boolean** | Is Domains enabled | 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::StatusResponse.new(versions: null,
-                                 online_workers: null,
-                                 online_content_apps: null,
-                                 database_connection: null,
-                                 redis_connection: null,
-                                 storage: null,
-                                 content_settings: null,
-                                 domain_enabled: null)
-```
-
-

data/docs/StorageClassEnum.md

@@ -1,16 +0,0 @@
-# PulpRpmClient::StorageClassEnum
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::StorageClassEnum.new()
-```
-
-

data/docs/StorageResponse.md

@@ -1,21 +0,0 @@
-# PulpRpmClient::StorageResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total** | **Integer** | Total number of bytes | 
-**used** | **Integer** | Number of bytes in use | 
-**free** | **Integer** | Number of free bytes | 
-
-## Code Sample
-
-```ruby
-require 'PulpRpmClient'
-
-instance = PulpRpmClient::StorageResponse.new(total: null,
-                                 used: null,
-                                 free: null)
-```
-
-