pulp_deb_client 3.5.0 → 3.5.1

data/docs/ContentInstallerFileIndicesApi.md

@@ -2,26 +2,25 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentInstallerFileIndicesApi.md#create) | **POST** /pulp/api/v3/content/deb/installer_file_indices/ | Create an installer file index
-[**list**](ContentInstallerFileIndicesApi.md#list) | **GET** /pulp/api/v3/content/deb/installer_file_indices/ | List InstallerFileIndices
-[**read**](ContentInstallerFileIndicesApi.md#read) | **GET** {deb_installer_file_index_href} | Inspect an installer file index
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentInstallerFileIndicesApi.md#create) | **POST** /pulp/api/v3/content/deb/installer_file_indices/ | Create an installer file index |
+| [**list**](ContentInstallerFileIndicesApi.md#list) | **GET** /pulp/api/v3/content/deb/installer_file_indices/ | List InstallerFileIndices |
+| [**read**](ContentInstallerFileIndicesApi.md#read) | **GET** {deb_installer_file_index_href} | Inspect an installer file index |
 
 
 ## create
 
-> DebInstallerFileIndexResponse create(deb_installer_file_index)
+> <DebInstallerFileIndexResponse> create(deb_installer_file_index)
 
 Create an installer file index
 
 An InstallerFileIndex represents the indices for a set of installer files.  Associated artifacts: Exactly one 'SHA256SUMS' and/or 'MD5SUMS' file.  Each InstallerFileIndes is associated with a single component-architecture combination within a single Release. Note that installer files are currently used exclusively for verbatim publications. The APT publisher (both simple and structured mode) does not make use of installer content.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -31,23 +30,40 @@ PulpDebClient.configure do |config|
 end
 
 api_instance = PulpDebClient::ContentInstallerFileIndicesApi.new
-deb_installer_file_index = PulpDebClient::DebInstallerFileIndex.new # DebInstallerFileIndex | 
+deb_installer_file_index = PulpDebClient::DebInstallerFileIndex.new({artifacts: 3.56, component: 'component_example', architecture: 'architecture_example'}) # DebInstallerFileIndex | 
 
 begin
-  #Create an installer file index
+  # Create an installer file index
   result = api_instance.create(deb_installer_file_index)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentInstallerFileIndicesApi->create: #{e}"
+  puts "Error when calling ContentInstallerFileIndicesApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DebInstallerFileIndexResponse>, Integer, Hash)> create_with_http_info(deb_installer_file_index)
+
+```ruby
+begin
+  # Create an installer file index
+  data, status_code, headers = api_instance.create_with_http_info(deb_installer_file_index)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DebInstallerFileIndexResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentInstallerFileIndicesApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **deb_installer_file_index** | [**DebInstallerFileIndex**](DebInstallerFileIndex.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_installer_file_index** | [**DebInstallerFileIndex**](DebInstallerFileIndex.md) |  |  |
 
 ### Return type
 
@@ -65,16 +81,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginateddebInstallerFileIndexResponseList list(opts)
+> <PaginateddebInstallerFileIndexResponseList> list(opts)
 
 List InstallerFileIndices
 
 An InstallerFileIndex represents the indices for a set of installer files.  Associated artifacts: Exactly one 'SHA256SUMS' and/or 'MD5SUMS' file.  Each InstallerFileIndes is associated with a single component-architecture combination within a single Release. Note that installer files are currently used exclusively for verbatim publications. The APT publisher (both simple and structured mode) does not make use of installer content.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -89,52 +105,69 @@ opts = {
   component: 'component_example', # String | Filter results where component matches value
   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  * `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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `component` - Component * `-component` - Component (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `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: ['-architecture'], # 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `component` - Component * `-component` - Component (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `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
   relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
   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
   sha256: 'sha256_example', # String | Filter results where sha256 matches value
-  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 InstallerFileIndices
+  # List InstallerFileIndices
   result = api_instance.list(opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentInstallerFileIndicesApi->list: #{e}"
+  puts "Error when calling ContentInstallerFileIndicesApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **architecture** | **String**| Filter results where architecture matches value | [optional] 
- **component** | **String**| Filter results where component matches value | [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  * &#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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;component&#x60; - Component * &#x60;-component&#x60; - Component (descending) * &#x60;architecture&#x60; - Architecture * &#x60;-architecture&#x60; - Architecture (descending) * &#x60;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (descending) * &#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] 
- **relative_path** | **String**| Filter results where relative_path matches value | [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] 
- **sha256** | **String**| Filter results where sha256 matches value | [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] 
+> <Array(<PaginateddebInstallerFileIndexResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List InstallerFileIndices
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginateddebInstallerFileIndexResponseList>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentInstallerFileIndicesApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **architecture** | **String** | Filter results where architecture matches value | [optional] |
+| **component** | **String** | Filter results where component matches value | [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  * &#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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;component&#x60; - Component * &#x60;-component&#x60; - Component (descending) * &#x60;architecture&#x60; - Architecture * &#x60;-architecture&#x60; - Architecture (descending) * &#x60;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (descending) * &#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] |
+| **relative_path** | **String** | Filter results where relative_path matches value | [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] |
+| **sha256** | **String** | Filter results where sha256 matches value | [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
 
@@ -152,16 +185,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> DebInstallerFileIndexResponse read(deb_installer_file_index_href, opts)
+> <DebInstallerFileIndexResponse> read(deb_installer_file_index_href, opts)
 
 Inspect an installer file index
 
 An InstallerFileIndex represents the indices for a set of installer files.  Associated artifacts: Exactly one 'SHA256SUMS' and/or 'MD5SUMS' file.  Each InstallerFileIndes is associated with a single component-architecture combination within a single Release. Note that installer files are currently used exclusively for verbatim publications. The APT publisher (both simple and structured mode) does not make use of installer content.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -173,27 +206,44 @@ end
 api_instance = PulpDebClient::ContentInstallerFileIndicesApi.new
 deb_installer_file_index_href = 'deb_installer_file_index_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 an installer file index
+  # Inspect an installer file index
   result = api_instance.read(deb_installer_file_index_href, opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentInstallerFileIndicesApi->read: #{e}"
+  puts "Error when calling ContentInstallerFileIndicesApi->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(<DebInstallerFileIndexResponse>, Integer, Hash)> read_with_http_info(deb_installer_file_index_href, opts)
 
+```ruby
+begin
+  # Inspect an installer file index
+  data, status_code, headers = api_instance.read_with_http_info(deb_installer_file_index_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DebInstallerFileIndexResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentInstallerFileIndicesApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **deb_installer_file_index_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 |
+| ---- | ---- | ----------- | ----- |
+| **deb_installer_file_index_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