pulpcore_client 3.69.2 → 3.70.0

data/docs/SigningServicesApi.md

@@ -2,25 +2,24 @@
 
 All URIs are relative to *http://localhost:24817*
 
-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
-
+| 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)
+> <PaginatedSigningServiceResponseList> list(opts)
 
 List signing services
 
 A ViewSet that supports browsing of existing signing services.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -34,39 +33,56 @@ 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)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  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.
+  ordering: ['-name'], # 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)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
-  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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List signing services
+  # List signing services
   result = api_instance.list(opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling SigningServicesApi->list: #{e}"
+  puts "Error when calling SigningServicesApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<PaginatedSigningServiceResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List signing services
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedSigningServiceResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling SigningServicesApi->list_with_http_info: #{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] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [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] 
- **q** | **String**| Filter results by using NOT, AND and OR operations on other filters | [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] 
+| 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] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [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] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [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
 
@@ -84,16 +100,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> SigningServiceResponse read(signing_service_href, opts)
+> <SigningServiceResponse> read(signing_service_href, opts)
 
 Inspect a signing service
 
 A ViewSet that supports browsing of existing signing services.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -105,27 +121,44 @@ end
 api_instance = PulpcoreClient::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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect a signing service
+  # Inspect a signing service
   result = api_instance.read(signing_service_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling SigningServicesApi->read: #{e}"
+  puts "Error when calling SigningServicesApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SigningServiceResponse>, Integer, Hash)> read_with_http_info(signing_service_href, opts)
+
+```ruby
+begin
+  # Inspect a signing service
+  data, status_code, headers = api_instance.read_with_http_info(signing_service_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SigningServiceResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling SigningServicesApi->read_with_http_info: #{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] 
+| 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
 

data/docs/StatesEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
 instance = PulpcoreClient::StatesEnum.new()
 ```
 
-

data/docs/StatusApi.md

@@ -2,34 +2,51 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**status_read**](StatusApi.md#status_read) | **GET** /pulp/api/v3/status/ | Inspect status of 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
+> <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
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 
 api_instance = PulpcoreClient::StatusApi.new
 
 begin
-  #Inspect status of Pulp
+  # Inspect status of Pulp
   result = api_instance.status_read
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling StatusApi->status_read: #{e}"
+  puts "Error when calling StatusApi->status_read: #{e}"
+end
+```
+
+#### Using the status_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<StatusResponse>, Integer, Hash)> status_read_with_http_info
+
+```ruby
+begin
+  # Inspect status of Pulp
+  data, status_code, headers = api_instance.status_read_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <StatusResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling StatusApi->status_read_with_http_info: #{e}"
 end
 ```
 

data/docs/StatusResponse.md

@@ -2,32 +2,33 @@
 
 ## 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_api_apps** | [**Array<ApiAppStatusResponse>**](ApiAppStatusResponse.md) | List of online api apps known to the application. An online api app is actively heartbeating and can serve the rest api to clients. | 
-**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 | 
+| 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_api_apps** | [**Array<ApiAppStatusResponse>**](ApiAppStatusResponse.md) | List of online api apps known to the application. An online api app is actively heartbeating and can serve the rest api to clients. |  |
+| **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
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::StatusResponse.new(versions: null,
-                                 online_workers: null,
-                                 online_api_apps: null,
-                                 online_content_apps: null,
-                                 database_connection: null,
-                                 redis_connection: null,
-                                 storage: null,
-                                 content_settings: null,
-                                 domain_enabled: null)
+instance = PulpcoreClient::StatusResponse.new(
+  versions: null,
+  online_workers: null,
+  online_api_apps: null,
+  online_content_apps: null,
+  database_connection: null,
+  redis_connection: null,
+  storage: null,
+  content_settings: null,
+  domain_enabled: null
+)
 ```
 
-

data/docs/StorageClassEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
 instance = PulpcoreClient::StorageClassEnum.new()
 ```
 
-

data/docs/StorageResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**total** | **Integer** | Total number of bytes | 
-**used** | **Integer** | Number of bytes in use | 
-**free** | **Integer** | Number of free bytes | 
+| 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
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::StorageResponse.new(total: null,
-                                 used: null,
-                                 free: null)
+instance = PulpcoreClient::StorageResponse.new(
+  total: null,
+  used: null,
+  free: null
+)
 ```
 
-

data/docs/TaskGroupOperationResponse.md

@@ -2,16 +2,17 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**task_group** | **String** | The href of the task group. | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **task_group** | **String** | The href of the task group. |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::TaskGroupOperationResponse.new(task_group: null)
+instance = PulpcoreClient::TaskGroupOperationResponse.new(
+  task_group: null
+)
 ```
 
-

data/docs/TaskGroupResponse.md

@@ -2,40 +2,41 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [optional] [readonly] 
-**description** | **String** | A description of the task group. | 
-**all_tasks_dispatched** | **Boolean** | Whether all tasks have been spawned for this task group. | 
-**waiting** | **Integer** | Number of tasks in the 'waiting' state | [optional] [readonly] 
-**skipped** | **Integer** | Number of tasks in the 'skipped' state | [optional] [readonly] 
-**running** | **Integer** | Number of tasks in the 'running' state | [optional] [readonly] 
-**completed** | **Integer** | Number of tasks in the 'completed' state | [optional] [readonly] 
-**canceled** | **Integer** | Number of tasks in the 'canceled' state | [optional] [readonly] 
-**failed** | **Integer** | Number of tasks in the 'failed' state | [optional] [readonly] 
-**canceling** | **Integer** | Number of tasks in the 'canceling' state | [optional] [readonly] 
-**group_progress_reports** | [**Array<GroupProgressReportResponse>**](GroupProgressReportResponse.md) |  | [optional] [readonly] 
-**tasks** | [**Array<MinimalTaskResponse>**](MinimalTaskResponse.md) |  | [optional] [readonly] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **description** | **String** | A description of the task group. |  |
+| **all_tasks_dispatched** | **Boolean** | Whether all tasks have been spawned for this task group. |  |
+| **waiting** | **Integer** | Number of tasks in the 'waiting' state | [optional][readonly] |
+| **skipped** | **Integer** | Number of tasks in the 'skipped' state | [optional][readonly] |
+| **running** | **Integer** | Number of tasks in the 'running' state | [optional][readonly] |
+| **completed** | **Integer** | Number of tasks in the 'completed' state | [optional][readonly] |
+| **canceled** | **Integer** | Number of tasks in the 'canceled' state | [optional][readonly] |
+| **failed** | **Integer** | Number of tasks in the 'failed' state | [optional][readonly] |
+| **canceling** | **Integer** | Number of tasks in the 'canceling' state | [optional][readonly] |
+| **group_progress_reports** | [**Array<GroupProgressReportResponse>**](GroupProgressReportResponse.md) |  | [optional][readonly] |
+| **tasks** | [**Array<MinimalTaskResponse>**](MinimalTaskResponse.md) |  | [optional][readonly] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::TaskGroupResponse.new(pulp_href: null,
-                                 prn: null,
-                                 description: null,
-                                 all_tasks_dispatched: null,
-                                 waiting: null,
-                                 skipped: null,
-                                 running: null,
-                                 completed: null,
-                                 canceled: null,
-                                 failed: null,
-                                 canceling: null,
-                                 group_progress_reports: null,
-                                 tasks: null)
+instance = PulpcoreClient::TaskGroupResponse.new(
+  pulp_href: null,
+  prn: null,
+  description: null,
+  all_tasks_dispatched: null,
+  waiting: null,
+  skipped: null,
+  running: null,
+  completed: null,
+  canceled: null,
+  failed: null,
+  canceling: null,
+  group_progress_reports: null,
+  tasks: null
+)
 ```
 
-