pulp_ansible_client 0.12.1 → 0.13.0

data/docs/PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.md

@@ -0,0 +1,75 @@
+# PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/{version}/docs-blob/ | 
+
+
+
+## read
+
+> CollectionVersionDocsResponse read(distro_base_path, name, namespace, path, version, opts)
+
+
+
+Returns a CollectionVersion object.
+
+### 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::PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+path = 'path_example' # String | 
+version = 'version_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
+  result = api_instance.read(distro_base_path, name, namespace, path, version, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **path** | **String**|  | 
+ **version** | **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
+
+[**CollectionVersionDocsResponse**](CollectionVersionDocsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleArtifactsCollectionsV3Api.md

@@ -5,6 +5,9 @@ All URIs are relative to *https://pulp*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create**](PulpAnsibleArtifactsCollectionsV3Api.md#create) | **POST** /pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/ | Upload a collection
+[**create_0**](PulpAnsibleArtifactsCollectionsV3Api.md#create_0) | **POST** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/content/{distro_base_path}/collections/artifacts/ | Upload a collection
+[**create_1**](PulpAnsibleArtifactsCollectionsV3Api.md#create_1) | **POST** /pulp_ansible/galaxy/default/api/v3/artifacts/collections/ | Upload a collection
+[**create_2**](PulpAnsibleArtifactsCollectionsV3Api.md#create_2) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/artifacts/ | Upload a collection
 
 
 
@@ -21,6 +24,12 @@ Create an artifact and trigger an asynchronous task to create Collection content
 ```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::PulpAnsibleArtifactsCollectionsV3Api.new
 path = 'path_example' # String | 
@@ -59,7 +68,202 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-No authorization required
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## create_0
+
+> AsyncOperationResponse create_0(distro_base_path, path, file, opts)
+
+Upload a collection
+
+Create an artifact and trigger an asynchronous task to create Collection content from it.
+
+### 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::PulpAnsibleArtifactsCollectionsV3Api.new
+distro_base_path = 'distro_base_path_example' # String | 
+path = 'path_example' # String | 
+file = File.new('/path/to/file') # File | The Collection tarball.
+opts = {
+  sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
+  expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
+  expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
+  expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
+}
+
+begin
+  #Upload a collection
+  result = api_instance.create_0(distro_base_path, path, file, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleArtifactsCollectionsV3Api->create_0: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **path** | **String**|  | 
+ **file** | **File**| The Collection tarball. | 
+ **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional] 
+ **expected_namespace** | **String**| The expected 'namespace' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_name** | **String**| The expected 'name' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_version** | **String**| The expected version of the Collection to be verified against the metadata during import. | [optional] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## create_1
+
+> AsyncOperationResponse create_1(file, opts)
+
+Upload a collection
+
+Create an artifact and trigger an asynchronous task to create Collection content from it.
+
+### 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::PulpAnsibleArtifactsCollectionsV3Api.new
+file = File.new('/path/to/file') # File | The Collection tarball.
+opts = {
+  sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
+  expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
+  expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
+  expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
+}
+
+begin
+  #Upload a collection
+  result = api_instance.create_1(file, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleArtifactsCollectionsV3Api->create_1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file** | **File**| The Collection tarball. | 
+ **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional] 
+ **expected_namespace** | **String**| The expected 'namespace' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_name** | **String**| The expected 'name' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_version** | **String**| The expected version of the Collection to be verified against the metadata during import. | [optional] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data, application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
+## create_2
+
+> AsyncOperationResponse create_2(distro_base_path, file, opts)
+
+Upload a collection
+
+Create an artifact and trigger an asynchronous task to create Collection content from it.
+
+### 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::PulpAnsibleArtifactsCollectionsV3Api.new
+distro_base_path = 'distro_base_path_example' # String | 
+file = File.new('/path/to/file') # File | The Collection tarball.
+opts = {
+  sha256: 'sha256_example', # String | An optional sha256 checksum of the uploaded file.
+  expected_namespace: 'expected_namespace_example', # String | The expected 'namespace' of the Collection to be verified against the metadata during import.
+  expected_name: 'expected_name_example', # String | The expected 'name' of the Collection to be verified against the metadata during import.
+  expected_version: 'expected_version_example' # String | The expected version of the Collection to be verified against the metadata during import.
+}
+
+begin
+  #Upload a collection
+  result = api_instance.create_2(distro_base_path, file, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleArtifactsCollectionsV3Api->create_2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **file** | **File**| The Collection tarball. | 
+ **sha256** | **String**| An optional sha256 checksum of the uploaded file. | [optional] 
+ **expected_namespace** | **String**| The expected 'namespace' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_name** | **String**| The expected 'name' of the Collection to be verified against the metadata during import. | [optional] 
+ **expected_version** | **String**| The expected version of the Collection to be verified against the metadata during import. | [optional] 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/PulpAnsibleDefaultApiApi.md

@@ -0,0 +1,50 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](PulpAnsibleDefaultApiApi.md#get) | **GET** /pulp_ansible/galaxy/default/api/ | 
+
+
+
+## get
+
+> get
+
+
+
+Return a response to the \"GET\" action.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+
+api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiApi.new
+
+begin
+  api_instance.get
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiApi->get: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/PulpAnsibleDefaultApiV3Api.md

@@ -0,0 +1,57 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3Api
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PulpAnsibleDefaultApiV3Api.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/ | 
+
+
+
+## read
+
+> RepoMetadataResponse read
+
+
+
+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::PulpAnsibleDefaultApiV3Api.new
+
+begin
+  result = api_instance.read
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3Api->read: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**RepoMetadataResponse**](RepoMetadataResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.md

@@ -0,0 +1,68 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.md#get) | **GET** /pulp_ansible/galaxy/default/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::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.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 PulpAnsibleDefaultApiV3ArtifactsCollectionsApi->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/PulpAnsibleDefaultApiV3CollectionVersionsAllApi.md

@@ -0,0 +1,57 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionVersionsAllApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleDefaultApiV3CollectionVersionsAllApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/collection_versions/all/ | 
+
+
+
+## list
+
+> Array<UnpaginatedCollectionVersionResponse> 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::PulpAnsibleDefaultApiV3CollectionVersionsAllApi.new
+
+begin
+  result = api_instance.list
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3CollectionVersionsAllApi->list: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<UnpaginatedCollectionVersionResponse>**](UnpaginatedCollectionVersionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3CollectionsAllApi.md

@@ -0,0 +1,71 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsAllApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleDefaultApiV3CollectionsAllApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/collections/all/ | 
+
+
+
+## list
+
+> Array<CollectionResponse> list(opts)
+
+
+
+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::PulpAnsibleDefaultApiV3CollectionsAllApi.new
+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(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3CollectionsAllApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+