pulp_rpm_client 3.27.2 → 3.28.0

data/docs/ContentRepoMetadataFilesApi.md

@@ -2,25 +2,24 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](ContentRepoMetadataFilesApi.md#list) | **GET** /pulp/api/v3/content/rpm/repo_metadata_files/ | List repo metadata files
-[**read**](ContentRepoMetadataFilesApi.md#read) | **GET** {rpm_repo_metadata_file_href} | Inspect a repo metadata file
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](ContentRepoMetadataFilesApi.md#list) | **GET** /pulp/api/v3/content/rpm/repo_metadata_files/ | List repo metadata files |
+| [**read**](ContentRepoMetadataFilesApi.md#read) | **GET** {rpm_repo_metadata_file_href} | Inspect a repo metadata file |
 
 
 ## list
 
-> PaginatedrpmRepoMetadataFileResponseList list(opts)
+> <PaginatedrpmRepoMetadataFileResponseList> list(opts)
 
 List repo metadata files
 
 RepoMetadataFile Viewset.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_rpm_client'
 # setup authorization
 PulpRpmClient.configure do |config|
@@ -33,46 +32,63 @@ api_instance = PulpRpmClient::ContentRepoMetadataFilesApi.new
 opts = {
   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  * `pk` - Pk * `-pk` - Pk (descending)
-  orphaned_for: 3.4, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
-  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: ['-pk'], # Array<String> | Ordering  * `pk` - Pk * `-pk` - Pk (descending)
+  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  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
   repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
   repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
   repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
-  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 repo metadata files
+  # List repo metadata files
   result = api_instance.list(opts)
   p result
 rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ContentRepoMetadataFilesApi->list: #{e}"
+  puts "Error when calling ContentRepoMetadataFilesApi->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(<PaginatedrpmRepoMetadataFileResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List repo metadata files
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedrpmRepoMetadataFileResponseList>
+rescue PulpRpmClient::ApiError => e
+  puts "Error when calling ContentRepoMetadataFilesApi->list_with_http_info: #{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] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **orphaned_for** | **Float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [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] 
- **repository_version** | **String**| Repository Version referenced by HREF/PRN | [optional] 
- **repository_version_added** | **String**| Repository Version referenced by HREF/PRN | [optional] 
- **repository_version_removed** | **String**| Repository Version referenced by HREF/PRN | [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] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [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] |
+| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [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
 
@@ -90,16 +106,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> RpmRepoMetadataFileResponse read(rpm_repo_metadata_file_href, opts)
+> <RpmRepoMetadataFileResponse> read(rpm_repo_metadata_file_href, opts)
 
 Inspect a repo metadata file
 
 RepoMetadataFile Viewset.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_rpm_client'
 # setup authorization
 PulpRpmClient.configure do |config|
@@ -111,27 +127,44 @@ end
 api_instance = PulpRpmClient::ContentRepoMetadataFilesApi.new
 rpm_repo_metadata_file_href = 'rpm_repo_metadata_file_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 repo metadata file
+  # Inspect a repo metadata file
   result = api_instance.read(rpm_repo_metadata_file_href, opts)
   p result
 rescue PulpRpmClient::ApiError => e
-  puts "Exception when calling ContentRepoMetadataFilesApi->read: #{e}"
+  puts "Error when calling ContentRepoMetadataFilesApi->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(<RpmRepoMetadataFileResponse>, Integer, Hash)> read_with_http_info(rpm_repo_metadata_file_href, opts)
+
+```ruby
+begin
+  # Inspect a repo metadata file
+  data, status_code, headers = api_instance.read_with_http_info(rpm_repo_metadata_file_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RpmRepoMetadataFileResponse>
+rescue PulpRpmClient::ApiError => e
+  puts "Error when calling ContentRepoMetadataFilesApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **rpm_repo_metadata_file_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 |
+| ---- | ---- | ----------- | ----- |
+| **rpm_repo_metadata_file_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/ContentSummaryResponse.md

@@ -2,20 +2,21 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**added** | **Hash<String, Object>** |  | 
-**removed** | **Hash<String, Object>** |  | 
-**present** | **Hash<String, Object>** |  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **added** | **Hash<String, Object>** |  |  |
+| **removed** | **Hash<String, Object>** |  |  |
+| **present** | **Hash<String, Object>** |  |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::ContentSummaryResponse.new(added: null,
-                                 removed: null,
-                                 present: null)
+instance = PulpRpmClient::ContentSummaryResponse.new(
+  added: null,
+  removed: null,
+  present: null
+)
 ```
 
-

data/docs/Copy.md

@@ -2,18 +2,19 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**config** | [**Object**](.md) | A JSON document describing sources, destinations, and content to be copied | 
-**dependency_solving** | **Boolean** | Also copy dependencies of the content being copied. | [optional] [default to true]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **config** | **Object** | Content to be copied into the given destinations from the given sources.  Its a list of dictionaries with the following available fields:  ```json [   {     \"source_repo_version\": <RepositoryVersion [pulp_href|prn]>,     \"dest_repo\": <RpmRepository [pulp_href|prn]>,     \"dest_base_version\": <int>,     \"content\": [<Content [pulp_href|prn]>, ...]   },   ... ] ```  If domains are enabled, the refered pulp objects must be part of the current domain.  For usage examples, refer to the advanced copy guide: <https://pulpproject.org/pulp_rpm/docs/user/guides/modify/#advanced-copy-workflow>  |  |
+| **dependency_solving** | **Boolean** | Also copy dependencies of the content being copied. | [optional][default to true] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpRpmClient'
+require 'pulp_rpm_client'
 
-instance = PulpRpmClient::Copy.new(config: null,
-                                 dependency_solving: null)
+instance = PulpRpmClient::Copy.new(
+  config: null,
+  dependency_solving: null
+)
 ```
 
-