pulp_ansible_client 0.12.1 → 0.13.0

data/docs/PatchedansibleGitRemote.md

@@ -4,26 +4,26 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**proxy_username** | **String** | The username to authenticte to the proxy. | [optional] 
-**username** | **String** | The username to be used for authentication when syncing. | [optional] 
-**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
-**proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] 
 **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] 
-**pulp_labels** | [**Object**](.md) |  | [optional] 
-**url** | **String** | The URL of an external content source. | [optional] 
-**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [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] 
 **proxy_password** | **String** | The password to authenticte to the proxy. | [optional] 
-**password** | **String** | The password to be used for authentication when syncing. | [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] 
+**pulp_labels** | [**Object**](.md) |  | [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] 
+**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] 
 **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] 
 **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] 
+**rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [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] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**proxy_username** | **String** | The username to authenticte to the proxy. | [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] 
 **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [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] 
+**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] 
+**url** | **String** | The URL of an external content source. | [optional] 
 **name** | **String** | A unique name for this remote. | [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] 
 **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] 
 
@@ -32,26 +32,26 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpAnsibleClient'
 
-instance = PulpAnsibleClient::PatchedansibleGitRemote.new(proxy_username: null,
-                                 username: null,
-                                 download_concurrency: null,
-                                 proxy_url: null,
-                                 tls_validation: null,
-                                 pulp_labels: null,
-                                 url: null,
-                                 rate_limit: null,
-                                 sock_connect_timeout: null,
-                                 sock_read_timeout: null,
+instance = PulpAnsibleClient::PatchedansibleGitRemote.new(tls_validation: null,
                                  proxy_password: null,
-                                 password: null,
-                                 connect_timeout: null,
+                                 pulp_labels: null,
+                                 max_retries: null,
+                                 total_timeout: null,
+                                 proxy_url: null,
                                  ca_cert: null,
                                  client_key: null,
+                                 rate_limit: null,
+                                 sock_connect_timeout: null,
                                  headers: null,
+                                 username: null,
+                                 download_concurrency: null,
+                                 password: null,
+                                 proxy_username: null,
+                                 sock_read_timeout: null,
                                  client_cert: null,
-                                 max_retries: null,
+                                 connect_timeout: null,
+                                 url: null,
                                  name: null,
-                                 total_timeout: null,
                                  metadata_only: null,
                                  git_ref: null)
 ```

data/docs/PulpAnsibleApiV3Api.md

@@ -14,13 +14,19 @@ Method | HTTP request | Description
 
 
 
-ViewSet for Repository Metadata.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3Api.new
 path = 'path_example' # String | 
@@ -52,7 +58,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3ArtifactsCollectionsApi.md

@@ -0,0 +1,68 @@
+# PulpAnsibleClient::PulpAnsibleApiV3ArtifactsCollectionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](PulpAnsibleApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/{path}/{filename} | 
+
+
+
+## get
+
+> get(filename, path, opts)
+
+
+
+Download collection.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3ArtifactsCollectionsApi.new
+filename = 'filename_example' # String | 
+path = 'path_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # 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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **filename** | **String**|  | 
+ **path** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/PulpAnsibleApiV3CollectionVersionsAllApi.md

@@ -14,13 +14,19 @@ Method | HTTP request | Description
 
 
 
-Returns paginated CollectionVersions list.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionVersionsAllApi.new
 path = 'path_example' # String | 
@@ -52,7 +58,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3CollectionsAllApi.md

@@ -14,13 +14,19 @@ Method | HTTP request | Description
 
 
 
-Unpaginated ViewSet for Collections.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsAllApi.new
 path = 'path_example' # String | 
@@ -58,7 +64,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3CollectionsApi.md

@@ -4,25 +4,88 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete**](PulpAnsibleApiV3CollectionsApi.md#delete) | **DELETE** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ | 
 [**list**](PulpAnsibleApiV3CollectionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/ | 
 [**read**](PulpAnsibleApiV3CollectionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ | 
 [**update**](PulpAnsibleApiV3CollectionsApi.md#update) | **PATCH** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/ | 
 
 
 
+## delete
+
+> AsyncOperationResponse delete(name, namespace, path)
+
+
+
+Legacy v3 endpoint.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+
+begin
+  result = api_instance.delete(name, namespace, path)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3CollectionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list
 
 > PaginatedCollectionResponseList list(path, opts)
 
 
 
-ViewSet for Collections.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi.new
 path = 'path_example' # String | 
@@ -64,7 +127,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -78,13 +141,19 @@ No authorization required
 
 
 
-ViewSet for Collections.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi.new
 name = 'name_example' # String | 
@@ -120,7 +189,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -134,13 +203,19 @@ No authorization required
 
 
 
-Trigger an asynchronous update task
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsApi.new
 name = 'name_example' # String | 
@@ -172,7 +247,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3CollectionsVersionsApi.md

@@ -4,24 +4,89 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**delete**](PulpAnsibleApiV3CollectionsVersionsApi.md#delete) | **DELETE** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/ | 
 [**list**](PulpAnsibleApiV3CollectionsVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/ | 
 [**read**](PulpAnsibleApiV3CollectionsVersionsApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/{version}/ | 
 
 
 
+## delete
+
+> AsyncOperationResponse delete(name, namespace, path, version)
+
+
+
+Legacy v3 endpoint.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi.new
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+version = 'version_example' # String | 
+
+begin
+  result = api_instance.delete(name, namespace, path, version)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3CollectionsVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **version** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list
 
-> PaginatedCollectionVersionResponseList list(name, namespace, path, opts)
+> PaginatedCollectionVersionListResponseList list(name, namespace, path, opts)
 
 
 
-Returns paginated CollectionVersions list.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi.new
 name = 'name_example' # String | 
@@ -75,11 +140,11 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**PaginatedCollectionVersionResponseList**](PaginatedCollectionVersionResponseList.md)
+[**PaginatedCollectionVersionListResponseList**](PaginatedCollectionVersionListResponseList.md)
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -93,13 +158,19 @@ No authorization required
 
 
 
-Returns a CollectionVersion object.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi.new
 name = 'name_example' # String | 
@@ -137,7 +208,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3CollectionsVersionsDocsBlobApi.md

@@ -14,13 +14,19 @@ Method | HTTP request | Description
 
 
 
-Returns a CollectionVersion object.
+Legacy v3 endpoint.
 
 ### Example
 
 ```ruby
 # load the gem
 require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
 
 api_instance = PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsDocsBlobApi.new
 name = 'name_example' # String | 
@@ -58,7 +64,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi.md

@@ -0,0 +1,75 @@
+# PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/content/{distro_base_path}/collections/all-collections/ | 
+
+
+
+## list
+
+> Array<CollectionResponse> list(distro_base_path, path, opts)
+
+
+
+Unpaginated ViewSet for Collections.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+path = 'path_example' # String | 
+opts = {
+  deprecated: true, # Boolean | 
+  name: 'name_example', # String | 
+  namespace: 'namespace_example', # String | 
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list(distro_base_path, path, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsAllCollectionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **path** | **String**|  | 
+ **deprecated** | **Boolean**|  | [optional] 
+ **name** | **String**|  | [optional] 
+ **namespace** | **String**|  | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**Array<CollectionResponse>**](CollectionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+