pulp_ansible_client 0.23.1 → 0.24.0

data/docs/PatchedansibleGitRemote.md

@@ -2,58 +2,59 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
-**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
-**name** | **String** | A unique name for this remote. | [optional] 
-**sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**url** | **String** | The URL of an external content source. | [optional] 
-**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
-**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
-**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
-**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**metadata_only** | **Boolean** | If True, only metadata about the content will be stored in Pulp. Clients will retrieve content from the remote URL. | [optional] 
-**git_ref** | **String** | A git ref. e.g.: branch, tag, or commit sha. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
+| **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
+| **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
+| **url** | **String** | The URL of an external content source. | [optional] |
+| **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
+| **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
+| **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
+| **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
+| **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **username** | **String** | The username to be used for authentication when syncing. | [optional] |
+| **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
+| **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
+| **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
+| **metadata_only** | **Boolean** | If True, only metadata about the content will be stored in Pulp. Clients will retrieve content from the remote URL. | [optional] |
+| **git_ref** | **String** | A git ref. e.g.: branch, tag, or commit sha. | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedansibleGitRemote.new(rate_limit: null,
-                                 proxy_username: null,
-                                 client_cert: null,
-                                 name: null,
-                                 sock_connect_timeout: null,
-                                 tls_validation: null,
-                                 url: null,
-                                 proxy_password: null,
-                                 ca_cert: null,
-                                 total_timeout: null,
-                                 proxy_url: null,
-                                 password: null,
-                                 max_retries: null,
-                                 pulp_labels: null,
-                                 headers: null,
-                                 username: null,
-                                 sock_read_timeout: null,
-                                 download_concurrency: null,
-                                 client_key: null,
-                                 connect_timeout: null,
-                                 metadata_only: null,
-                                 git_ref: null)
+instance = PulpAnsibleClient::PatchedansibleGitRemote.new(
+  pulp_labels: null,
+  name: null,
+  proxy_username: null,
+  proxy_url: null,
+  sock_read_timeout: null,
+  connect_timeout: null,
+  download_concurrency: null,
+  url: null,
+  sock_connect_timeout: null,
+  headers: null,
+  client_cert: null,
+  ca_cert: null,
+  total_timeout: null,
+  max_retries: null,
+  proxy_password: null,
+  username: null,
+  tls_validation: null,
+  client_key: null,
+  password: null,
+  rate_limit: null,
+  metadata_only: null,
+  git_ref: null
+)
 ```
 
-

data/docs/PatchedansibleRoleRemote.md

@@ -2,56 +2,57 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | A unique name for this remote. | [optional] 
-**url** | **String** | The URL of an external content source. | [optional] 
-**ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
-**client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] 
-**client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
-**tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
-**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] 
-**pulp_labels** | **Hash<String, String>** |  | [optional] 
-**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
-**max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] 
-**policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content.  * `immediate` - immediate * `When syncing, download all metadata and content now.` - When syncing, download all metadata and content now. | [optional] 
-**total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] 
-**headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] 
-**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **url** | **String** | The URL of an external content source. | [optional] |
+| **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
+| **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
+| **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
+| **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
+| **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
+| **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
+| **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **username** | **String** | The username to be used for authentication when syncing. | [optional] |
+| **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
+| **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
+| **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content.  * `immediate` - When syncing, download all metadata and content now. | [optional] |
+| **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
+| **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
-instance = PulpAnsibleClient::PatchedansibleRoleRemote.new(name: null,
-                                 url: null,
-                                 ca_cert: null,
-                                 client_cert: null,
-                                 client_key: null,
-                                 tls_validation: null,
-                                 proxy_url: null,
-                                 proxy_username: null,
-                                 proxy_password: null,
-                                 username: null,
-                                 password: null,
-                                 pulp_labels: null,
-                                 download_concurrency: null,
-                                 max_retries: null,
-                                 policy: null,
-                                 total_timeout: null,
-                                 connect_timeout: null,
-                                 sock_connect_timeout: null,
-                                 sock_read_timeout: null,
-                                 headers: null,
-                                 rate_limit: null)
+instance = PulpAnsibleClient::PatchedansibleRoleRemote.new(
+  name: null,
+  url: null,
+  ca_cert: null,
+  client_cert: null,
+  client_key: null,
+  tls_validation: null,
+  proxy_url: null,
+  proxy_username: null,
+  proxy_password: null,
+  username: null,
+  password: null,
+  pulp_labels: null,
+  download_concurrency: null,
+  max_retries: null,
+  policy: null,
+  total_timeout: null,
+  connect_timeout: null,
+  sock_connect_timeout: null,
+  sock_read_timeout: null,
+  headers: null,
+  rate_limit: null
+)
 ```
 
-

data/docs/PolicyEnum.md

@@ -2,15 +2,14 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpAnsibleClient'
+require 'pulp_ansible_client'
 
 instance = PulpAnsibleClient::PolicyEnum.new()
 ```
 
-

data/docs/PulpAnsibleApiApi.md

@@ -2,10 +2,9 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](PulpAnsibleApiApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get**](PulpAnsibleApiApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/ |  |
 
 
 ## get
@@ -16,34 +15,52 @@ Method | HTTP request | Description
 
 Return a response to the \"GET\" action.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiApi.new
 path = 'path_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.get(path, opts)
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleApiApi->get: #{e}"
+  puts "Error when calling PulpAnsibleApiApi->get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_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)> get_with_http_info(path, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_with_http_info(path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleApiApi->get_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **path** | **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/PulpAnsibleApiV3Api.md

@@ -2,24 +2,23 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**read**](PulpAnsibleApiV3Api.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**read**](PulpAnsibleApiV3Api.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/ |  |
 
 
 ## read
 
-> RepoMetadataResponse read(path, opts)
+> <RepoMetadataResponse> read(path, opts)
 
 
 
 Legacy v3 endpoint.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -31,26 +30,44 @@ end
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3Api.new
 path = 'path_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(path, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleApiV3Api->read: #{e}"
+  puts "Error when calling PulpAnsibleApiV3Api->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(<RepoMetadataResponse>, Integer, Hash)> read_with_http_info(path, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.read_with_http_info(path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RepoMetadataResponse>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleApiV3Api->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **path** | **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/PulpAnsibleApiV3ArtifactsCollectionsApi.md

@@ -2,10 +2,9 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](PulpAnsibleApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/{path}/{filename} | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get**](PulpAnsibleApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/{path}/{filename} |  |
 
 
 ## get
@@ -16,10 +15,10 @@ Method | HTTP request | Description
 
 Download collection.
 
-### 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::PulpAnsibleApiV3ArtifactsCollectionsApi.new
 filename = 'filename_example' # String | 
 path = 'path_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.get(filename, path, opts)
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleApiV3ArtifactsCollectionsApi->get: #{e}"
+  puts "Error when calling PulpAnsibleApiV3ArtifactsCollectionsApi->get: #{e}"
 end
 ```
 
-### Parameters
+#### Using the get_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)> get_with_http_info(filename, path, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_with_http_info(filename, path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleApiV3ArtifactsCollectionsApi->get_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **filename** | **String**|  | 
- **path** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **filename** | **String** |  |  |
+| **path** | **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/PulpAnsibleApiV3CollectionVersionsAllApi.md

@@ -2,24 +2,23 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](PulpAnsibleApiV3CollectionVersionsAllApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collection_versions/all/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](PulpAnsibleApiV3CollectionVersionsAllApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collection_versions/all/ |  |
 
 
 ## list
 
-> Array<UnpaginatedCollectionVersionResponse> list(path, opts)
+> <Array<UnpaginatedCollectionVersionResponse>> list(path, opts)
 
 
 
 Legacy v3 endpoint.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -31,26 +30,44 @@ end
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionVersionsAllApi.new
 path = 'path_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.list(path, opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleApiV3CollectionVersionsAllApi->list: #{e}"
+  puts "Error when calling PulpAnsibleApiV3CollectionVersionsAllApi->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(<Array<UnpaginatedCollectionVersionResponse>>, Integer, Hash)> list_with_http_info(path, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.list_with_http_info(path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<UnpaginatedCollectionVersionResponse>>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleApiV3CollectionVersionsAllApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **path** | **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 |
+| ---- | ---- | ----------- | ----- |
+| **path** | **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