pulp_file_client 3.69.1 → 3.70.0

data/docs/AsyncOperationResponse.md

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

data/docs/ContentFilesApi.md

@@ -2,26 +2,25 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content
-[**list**](ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents
-[**read**](ContentFilesApi.md#read) | **GET** {file_file_content_href} | Inspect a file content
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentFilesApi.md#create) | **POST** /pulp/api/v3/content/file/files/ | Create a file content |
+| [**list**](ContentFilesApi.md#list) | **GET** /pulp/api/v3/content/file/files/ | List file contents |
+| [**read**](ContentFilesApi.md#read) | **GET** {file_file_content_href} | Inspect a file content |
 
 
 ## create
 
-> AsyncOperationResponse create(relative_path, opts)
+> <AsyncOperationResponse> create(relative_path, opts)
 
 Create a file content
 
 Trigger an asynchronous task to create content,optionally create new repository version.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
@@ -35,31 +34,48 @@ relative_path = 'relative_path_example' # String | Path where the artifact is lo
 opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
   upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
   file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
 }
 
 begin
-  #Create a file content
+  # Create a file content
   result = api_instance.create(relative_path, opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling ContentFilesApi->create: #{e}"
+  puts "Error when calling ContentFilesApi->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(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(relative_path, opts)
+
+```ruby
+begin
+  # Create a file content
+  data, status_code, headers = api_instance.create_with_http_info(relative_path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpFileClient::ApiError => e
+  puts "Error when calling ContentFilesApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | 
- **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
- **artifact** | **String**| Artifact file representing the physical content | [optional] 
- **file** | **File**| An uploaded file that may be turned into the content unit. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the content unit. | [optional] 
- **file_url** | **String**| A url that Pulp can download and turn into the content unit. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **relative_path** | **String** | Path where the artifact is located relative to distributions base_path |  |
+| **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
+| **artifact** | **String** | Artifact file representing the physical content | [optional] |
+| **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
+| **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
+| **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
 
 ### Return type
 
@@ -77,16 +93,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedfileFileContentResponseList list(opts)
+> <PaginatedfileFileContentResponseList> list(opts)
 
 List file contents
 
  FileContent represents a single file and its metadata, which can be added and removed from repositories.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
@@ -99,50 +115,67 @@ api_instance = PulpFileClient::ContentFilesApi.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  * `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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `digest` - Digest * `-digest` - Digest (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: ['-digest'], # 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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `digest` - Digest * `-digest` - Digest (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 | 
-  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 file contents
+  # List file contents
   result = api_instance.list(opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling ContentFilesApi->list: #{e}"
+  puts "Error when calling ContentFilesApi->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
-------------- | ------------- | ------------- | -------------
- **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;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (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**|  | [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(<PaginatedfileFileContentResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List file contents
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedfileFileContentResponseList>
+rescue PulpFileClient::ApiError => e
+  puts "Error when calling ContentFilesApi->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;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;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (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** |  | [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
 
@@ -160,16 +193,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> FileFileContentResponse read(file_file_content_href, opts)
+> <FileFileContentResponse> read(file_file_content_href, opts)
 
 Inspect a file content
 
  FileContent represents a single file and its metadata, which can be added and removed from repositories.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_file_client'
 # setup authorization
 PulpFileClient.configure do |config|
@@ -181,27 +214,44 @@ end
 api_instance = PulpFileClient::ContentFilesApi.new
 file_file_content_href = 'file_file_content_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 file content
+  # Inspect a file content
   result = api_instance.read(file_file_content_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
-  puts "Exception when calling ContentFilesApi->read: #{e}"
+  puts "Error when calling ContentFilesApi->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(<FileFileContentResponse>, Integer, Hash)> read_with_http_info(file_file_content_href, opts)
 
+```ruby
+begin
+  # Inspect a file content
+  data, status_code, headers = api_instance.read_with_http_info(file_file_content_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileFileContentResponse>
+rescue PulpFileClient::ApiError => e
+  puts "Error when calling ContentFilesApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **file_file_content_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 |
+| ---- | ---- | ----------- | ----- |
+| **file_file_content_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 'PulpFileClient'
+require 'pulp_file_client'
 
-instance = PulpFileClient::ContentSummaryResponse.new(added: null,
-                                 removed: null,
-                                 present: null)
+instance = PulpFileClient::ContentSummaryResponse.new(
+  added: null,
+  removed: null,
+  present: null
+)
 ```
 
-