pulp_ansible_client 0.12.1 → 0.13.0

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi.md

@@ -0,0 +1,67 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/ | 
+
+
+
+## read
+
+> RepoMetadataResponse read(distro_base_path, opts)
+
+
+
+ViewSet for Repository Metadata.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi.new
+distro_base_path = 'distro_base_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
+  result = api_instance.read(distro_base_path, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_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
+
+[**RepoMetadataResponse**](RepoMetadataResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md

@@ -0,0 +1,68 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi
+
+All URIs are relative to *https://pulp*
+
+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
+
+> download(distro_base_path, filename, opts)
+
+
+
+Collection download 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+filename = 'filename_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.download(distro_base_path, filename, opts)
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi->download: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **filename** | **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/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md

@@ -0,0 +1,256 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi
+
+All URIs are relative to *https://pulp*
+
+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)
+
+
+
+Trigger an asynchronous delete task
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+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}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedCollectionResponseList list(distro_base_path, opts)
+
+
+
+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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+opts = {
+  deprecated: true, # Boolean | 
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  namespace: 'namespace_example', # String | 
+  offset: 56, # Integer | The initial index from which to return the results.
+  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, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->list: #{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] 
+ **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
+
+[**PaginatedCollectionResponseList**](PaginatedCollectionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> CollectionResponse read(distro_base_path, name, namespace, opts)
+
+
+
+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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_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, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **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
+
+[**CollectionResponse**](CollectionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(distro_base_path, name, namespace, body)
+
+
+
+Trigger an asynchronous update task
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+body = nil # Object | 
+
+begin
+  result = api_instance.update(distro_base_path, name, namespace, body)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **body** | **Object**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md

@@ -0,0 +1,217 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/{version}/ | 
+[**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/ | 
+[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/{version}/ | 
+
+
+
+## delete
+
+> AsyncOperationResponse delete(distro_base_path, name, namespace, version)
+
+
+
+Trigger an asynchronous delete task
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+version = 'version_example' # String | 
+
+begin
+  result = api_instance.delete(distro_base_path, name, namespace, version)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **version** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedCollectionVersionListResponseList list(distro_base_path, name, namespace, opts)
+
+
+
+Returns paginated CollectionVersions list.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_example' # String | 
+opts = {
+  is_highest: true, # Boolean | 
+  limit: 56, # Integer | Number of results to return per page.
+  name2: 'name_example', # String | 
+  namespace2: 'namespace_example', # String | 
+  offset: 56, # Integer | The initial index from which to return the results.
+  q: 'q_example', # String | 
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  tags: 'tags_example', # String | Filter by comma separate list of tags that must all be matched
+  version: 'version_example', # String | Filter results where version matches value
+  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, name, namespace, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **String**|  | 
+ **is_highest** | **Boolean**|  | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name2** | **String**|  | [optional] 
+ **namespace2** | **String**|  | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **q** | **String**|  | [optional] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [optional] 
+ **tags** | **String**| Filter by comma separate list of tags that must all be matched | [optional] 
+ **version** | **String**| Filter results where version matches value | [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
+
+[**PaginatedCollectionVersionListResponseList**](PaginatedCollectionVersionListResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> CollectionVersionResponse read(distro_base_path, name, namespace, 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_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, version, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **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
+
+[**CollectionVersionResponse**](CollectionVersionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.md

@@ -0,0 +1,73 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/collections/index/{namespace}/{name}/versions/{version}/docs-blob/ | 
+
+
+
+## read
+
+> CollectionVersionDocsResponse read(distro_base_path, name, namespace, 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::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+namespace = 'namespace_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, version, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **namespace** | **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
+