pulp_container_client 2.22.1 → 2.23.0

data/docs/RepositoriesContainerPushVersionsApi.md

@@ -2,27 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete**](RepositoriesContainerPushVersionsApi.md#delete) | **DELETE** {container_container_push_repository_version_href} | Delete a repository version
-[**list**](RepositoriesContainerPushVersionsApi.md#list) | **GET** {container_container_push_repository_href}versions/ | List repository versions
-[**read**](RepositoriesContainerPushVersionsApi.md#read) | **GET** {container_container_push_repository_version_href} | Inspect a repository version
-[**repair**](RepositoriesContainerPushVersionsApi.md#repair) | **POST** {container_container_push_repository_version_href}repair/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete**](RepositoriesContainerPushVersionsApi.md#delete) | **DELETE** {container_container_push_repository_version_href} | Delete a repository version |
+| [**list**](RepositoriesContainerPushVersionsApi.md#list) | **GET** {container_container_push_repository_href}versions/ | List repository versions |
+| [**read**](RepositoriesContainerPushVersionsApi.md#read) | **GET** {container_container_push_repository_version_href} | Inspect a repository version |
+| [**repair**](RepositoriesContainerPushVersionsApi.md#repair) | **POST** {container_container_push_repository_version_href}repair/ |  |
 
 
 ## delete
 
-> AsyncOperationResponse delete(container_container_push_repository_version_href)
+> <AsyncOperationResponse> delete(container_container_push_repository_version_href)
 
 Delete a repository version
 
 Trigger an asynchronous task to delete a repository version.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_container_client'
 # setup authorization
 PulpContainerClient.configure do |config|
@@ -35,20 +34,37 @@ api_instance = PulpContainerClient::RepositoriesContainerPushVersionsApi.new
 container_container_push_repository_version_href = 'container_container_push_repository_version_href_example' # String | 
 
 begin
-  #Delete a repository version
+  # Delete a repository version
   result = api_instance.delete(container_container_push_repository_version_href)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RepositoriesContainerPushVersionsApi->delete: #{e}"
+  puts "Error when calling RepositoriesContainerPushVersionsApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(container_container_push_repository_version_href)
+
+```ruby
+begin
+  # Delete a repository version
+  data, status_code, headers = api_instance.delete_with_http_info(container_container_push_repository_version_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpContainerClient::ApiError => e
+  puts "Error when calling RepositoriesContainerPushVersionsApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **container_container_push_repository_version_href** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_container_push_repository_version_href** | **String** |  |  |
 
 ### Return type
 
@@ -66,16 +82,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedRepositoryVersionResponseList list(container_container_push_repository_href, opts)
+> <PaginatedRepositoryVersionResponseList> list(container_container_push_repository_href, opts)
 
 List repository versions
 
 ContainerPushRepositoryVersion represents a single container push repository version.  Repository versions of a push repository are not allowed to be deleted. Versioning of such repositories, as well as creation/removal, happens automatically without explicit user actions. Users could make a repository not functional by accident if allowed to delete repository versions.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_container_client'
 # setup authorization
 PulpContainerClient.configure do |config|
@@ -88,66 +104,85 @@ api_instance = PulpContainerClient::RepositoriesContainerPushVersionsApi.new
 container_container_push_repository_href = 'container_container_push_repository_href_example' # String | 
 opts = {
   content: 'content_example', # String | Content Unit referenced by HREF/PRN
-  content__in: ['content__in_example'], # Array<String> | Multiple values may be separated by commas.
+  content__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   limit: 56, # Integer | Number of results to return per page.
   number: 56, # Integer | Filter results where number matches value
   number__gt: 56, # Integer | Filter results where number is greater than value
   number__gte: 56, # Integer | Filter results where number is greater than or equal to value
   number__lt: 56, # Integer | Filter results where number is less than value
   number__lte: 56, # Integer | Filter results where number is less than or equal to value
-  number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
+  number__range: [37], # Array<Integer> | Filter results where number is between two comma separated values
   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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created matches value
-  pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
-  pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
-  pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
-  pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
-  pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
+  ordering: ['-complete'], # 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) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_created: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created matches value
+  pulp_created__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than value
+  pulp_created__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than or equal to value
+  pulp_created__isnull: true, # Boolean | Filter results where pulp_created has a null value
+  pulp_created__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than value
+  pulp_created__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [Time.now], # Array<Time> | Filter results where pulp_created is between two comma separated values
+  pulp_href__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 repository versions
+  # List repository versions
   result = api_instance.list(container_container_push_repository_href, opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RepositoriesContainerPushVersionsApi->list: #{e}"
+  puts "Error when calling RepositoriesContainerPushVersionsApi->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(<PaginatedRepositoryVersionResponseList>, Integer, Hash)> list_with_http_info(container_container_push_repository_href, opts)
+
+```ruby
+begin
+  # List repository versions
+  data, status_code, headers = api_instance.list_with_http_info(container_container_push_repository_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedRepositoryVersionResponseList>
+rescue PulpContainerClient::ApiError => e
+  puts "Error when calling RepositoriesContainerPushVersionsApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **container_container_push_repository_href** | **String**|  | 
- **content** | **String**| Content Unit referenced by HREF/PRN | [optional] 
- **content__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **number** | **Integer**| Filter results where number matches value | [optional] 
- **number__gt** | **Integer**| Filter results where number is greater than value | [optional] 
- **number__gte** | **Integer**| Filter results where number is greater than or equal to value | [optional] 
- **number__lt** | **Integer**| Filter results where number is less than value | [optional] 
- **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional] 
- **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [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;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (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_created** | **DateTime**| Filter results where pulp_created matches value | [optional] 
- **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
- **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
- **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
- **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
- **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [optional] 
- **pulp_href__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 |
+| ---- | ---- | ----------- | ----- |
+| **container_container_push_repository_href** | **String** |  |  |
+| **content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
+| **content__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **number** | **Integer** | Filter results where number matches value | [optional] |
+| **number__gt** | **Integer** | Filter results where number is greater than value | [optional] |
+| **number__gte** | **Integer** | Filter results where number is greater than or equal to value | [optional] |
+| **number__lt** | **Integer** | Filter results where number is less than value | [optional] |
+| **number__lte** | **Integer** | Filter results where number is less than or equal to value | [optional] |
+| **number__range** | [**Array&lt;Integer&gt;**](Integer.md) | Filter results where number is between two comma separated values | [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;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (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_created** | **Time** | Filter results where pulp_created matches value | [optional] |
+| **pulp_created__gt** | **Time** | Filter results where pulp_created is greater than value | [optional] |
+| **pulp_created__gte** | **Time** | Filter results where pulp_created is greater than or equal to value | [optional] |
+| **pulp_created__isnull** | **Boolean** | Filter results where pulp_created has a null value | [optional] |
+| **pulp_created__lt** | **Time** | Filter results where pulp_created is less than value | [optional] |
+| **pulp_created__lte** | **Time** | Filter results where pulp_created is less than or equal to value | [optional] |
+| **pulp_created__range** | [**Array&lt;Time&gt;**](Time.md) | Filter results where pulp_created is between two comma separated values | [optional] |
+| **pulp_href__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
 
@@ -165,16 +200,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> RepositoryVersionResponse read(container_container_push_repository_version_href, opts)
+> <RepositoryVersionResponse> read(container_container_push_repository_version_href, opts)
 
 Inspect a repository version
 
 ContainerPushRepositoryVersion represents a single container push repository version.  Repository versions of a push repository are not allowed to be deleted. Versioning of such repositories, as well as creation/removal, happens automatically without explicit user actions. Users could make a repository not functional by accident if allowed to delete repository versions.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_container_client'
 # setup authorization
 PulpContainerClient.configure do |config|
@@ -186,27 +221,44 @@ end
 api_instance = PulpContainerClient::RepositoriesContainerPushVersionsApi.new
 container_container_push_repository_version_href = 'container_container_push_repository_version_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 repository version
+  # Inspect a repository version
   result = api_instance.read(container_container_push_repository_version_href, opts)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RepositoriesContainerPushVersionsApi->read: #{e}"
+  puts "Error when calling RepositoriesContainerPushVersionsApi->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(<RepositoryVersionResponse>, Integer, Hash)> read_with_http_info(container_container_push_repository_version_href, opts)
+
+```ruby
+begin
+  # Inspect a repository version
+  data, status_code, headers = api_instance.read_with_http_info(container_container_push_repository_version_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RepositoryVersionResponse>
+rescue PulpContainerClient::ApiError => e
+  puts "Error when calling RepositoriesContainerPushVersionsApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **container_container_push_repository_version_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 |
+| ---- | ---- | ----------- | ----- |
+| **container_container_push_repository_version_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
 
@@ -224,16 +276,16 @@ Name | Type | Description  | Notes
 
 ## repair
 
-> AsyncOperationResponse repair(container_container_push_repository_version_href, repair)
+> <AsyncOperationResponse> repair(container_container_push_repository_version_href, repair)
 
 
 
 Trigger an asynchronous task to repair a repository version.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_container_client'
 # setup authorization
 PulpContainerClient.configure do |config|
@@ -247,20 +299,38 @@ container_container_push_repository_version_href = 'container_container_push_rep
 repair = PulpContainerClient::Repair.new # Repair | 
 
 begin
+  
   result = api_instance.repair(container_container_push_repository_version_href, repair)
   p result
 rescue PulpContainerClient::ApiError => e
-  puts "Exception when calling RepositoriesContainerPushVersionsApi->repair: #{e}"
+  puts "Error when calling RepositoriesContainerPushVersionsApi->repair: #{e}"
 end
 ```
 
-### Parameters
+#### Using the repair_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> repair_with_http_info(container_container_push_repository_version_href, repair)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.repair_with_http_info(container_container_push_repository_version_href, repair)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpContainerClient::ApiError => e
+  puts "Error when calling RepositoriesContainerPushVersionsApi->repair_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **container_container_push_repository_version_href** | **String**|  | 
- **repair** | [**Repair**](Repair.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **container_container_push_repository_version_href** | **String** |  |  |
+| **repair** | [**Repair**](Repair.md) |  |  |
 
 ### Return type