pulp_ansible_client 0.23.1 → 0.24.0

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md

@@ -2,10 +2,9 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**download**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md#download) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/artifacts/{filename} | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**download**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md#download) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/artifacts/{filename} |  |
 
 
 ## download
@@ -16,10 +15,10 @@ Method | HTTP request | Description
 
 Collection download endpoint.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -32,26 +31,44 @@ api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCol
 distro_base_path = 'distro_base_path_example' # String | 
 filename = 'filename_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
+  
   api_instance.download(distro_base_path, filename, opts)
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi->download: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi->download: #{e}"
 end
 ```
 
-### Parameters
+#### Using the download_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
+> <Array(nil, Integer, Hash)> download_with_http_info(distro_base_path, filename, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.download_with_http_info(distro_base_path, filename, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi->download_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distro_base_path** | **String**|  | 
- **filename** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **distro_base_path** | **String** |  |  |
+| **filename** | **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/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md

@@ -2,27 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ | 
-[**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/ | 
-[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ | 
-[**update**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#update) | **PATCH** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ |  |
+| [**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/ |  |
+| [**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ |  |
+| [**update**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md#update) | **PATCH** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/ |  |
 
 
 ## delete
 
-> AsyncOperationResponse delete(distro_base_path, name, namespace)
+> <AsyncOperationResponse> delete(distro_base_path, name, namespace)
 
 
 
 Trigger an asynchronous delete task
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -37,21 +36,39 @@ name = 'name_example' # String |
 namespace = 'namespace_example' # String | 
 
 begin
+  
   result = api_instance.delete(distro_base_path, name, namespace)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->delete: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->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(distro_base_path, name, namespace)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.delete_with_http_info(distro_base_path, name, namespace)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distro_base_path** | **String**|  | 
- **name** | **String**|  | 
- **namespace** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **distro_base_path** | **String** |  |  |
+| **name** | **String** |  |  |
+| **namespace** | **String** |  |  |
 
 ### Return type
 
@@ -69,16 +86,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginatedCollectionResponseList list(distro_base_path, opts)
+> <PaginatedCollectionResponseList> list(distro_base_path, opts)
 
 
 
 ViewSet for Collections.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -95,41 +112,59 @@ opts = {
   name: 'name_example', # String | 
   namespace: 'namespace_example', # String | 
   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) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `name` - Name * `-name` - Name (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) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `name` - Name * `-name` - Name (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
+  
   result = api_instance.list(distro_base_path, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->list: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->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(<PaginatedCollectionResponseList>, Integer, Hash)> list_with_http_info(distro_base_path, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.list_with_http_info(distro_base_path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCollectionResponseList>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distro_base_path** | **String**|  | 
- **deprecated** | **Boolean**|  | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**|  | [optional] 
- **namespace** | **String**|  | [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;namespace&#x60; - Namespace * &#x60;-namespace&#x60; - Namespace (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (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 |
+| ---- | ---- | ----------- | ----- |
+| **distro_base_path** | **String** |  |  |
+| **deprecated** | **Boolean** |  | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **name** | **String** |  | [optional] |
+| **namespace** | **String** |  | [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;namespace&#x60; - Namespace * &#x60;-namespace&#x60; - Namespace (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (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
 
@@ -147,16 +182,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> CollectionResponse read(distro_base_path, name, namespace, opts)
+> <CollectionResponse> read(distro_base_path, name, namespace, opts)
 
 
 
 ViewSet for Collections.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -170,28 +205,46 @@ distro_base_path = 'distro_base_path_example' # String |
 name = 'name_example' # String | 
 namespace = 'namespace_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
+  
   result = api_instance.read(distro_base_path, name, namespace, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->read: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->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(<CollectionResponse>, Integer, Hash)> read_with_http_info(distro_base_path, name, namespace, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.read_with_http_info(distro_base_path, name, namespace, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CollectionResponse>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distro_base_path** | **String**|  | 
- **name** | **String**|  | 
- **namespace** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **distro_base_path** | **String** |  |  |
+| **name** | **String** |  |  |
+| **namespace** | **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
 
@@ -209,16 +262,16 @@ Name | Type | Description  | Notes
 
 ## update
 
-> AsyncOperationResponse update(distro_base_path, name, namespace, patched_collection)
+> <AsyncOperationResponse> update(distro_base_path, name, namespace, patched_collection)
 
 
 
 Trigger an asynchronous update task
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -234,22 +287,40 @@ namespace = 'namespace_example' # String |
 patched_collection = PulpAnsibleClient::PatchedCollection.new # PatchedCollection | 
 
 begin
+  
   result = api_instance.update(distro_base_path, name, namespace, patched_collection)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->update: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->update: #{e}"
 end
 ```
 
-### Parameters
+#### Using the update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> update_with_http_info(distro_base_path, name, namespace, patched_collection)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.update_with_http_info(distro_base_path, name, namespace, patched_collection)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->update_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distro_base_path** | **String**|  | 
- **name** | **String**|  | 
- **namespace** | **String**|  | 
- **patched_collection** | [**PatchedCollection**](PatchedCollection.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **distro_base_path** | **String** |  |  |
+| **name** | **String** |  |  |
+| **namespace** | **String** |  |  |
+| **patched_collection** | [**PatchedCollection**](PatchedCollection.md) |  |  |
 
 ### Return type