pulp_ansible_client 0.16.6 → 0.17.0

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md

@@ -0,0 +1,353 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#create) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ | 
+[**delete**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#delete) | **DELETE** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | 
+[**list**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/ | 
+[**partial_update**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#partial_update) | **PATCH** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | 
+[**read**](PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/content/{distro_base_path}/namespaces/{name}/ | 
+
+
+
+## create
+
+> AsyncOperationResponse create(distro_base_path, name, opts)
+
+
+
+Custom exception handler mixin class.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | Required named, only accepts lowercase, numbers and underscores.
+opts = {
+  company: 'company_example', # String | Optional namespace company owner.
+  email: 'email_example', # String | Optional namespace contact email.
+  description: 'description_example', # String | Optional short description.
+  resources: 'resources_example', # String | Optional resource page in markdown format.
+  links: PulpAnsibleClient::NamespaceLink.new, # Array<NamespaceLink> | Labeled related links.
+  avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace
+}
+
+begin
+  result = api_instance.create(distro_base_path, name, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**| Required named, only accepts lowercase, numbers and underscores. | 
+ **company** | **String**| Optional namespace company owner. | [optional] 
+ **email** | **String**| Optional namespace contact email. | [optional] 
+ **description** | **String**| Optional short description. | [optional] 
+ **resources** | **String**| Optional resource page in markdown format. | [optional] 
+ **links** | [**Array&lt;NamespaceLink&gt;**](NamespaceLink.md)| Labeled related links. | [optional] 
+ **avatar** | **File**| Optional avatar image for Namespace | [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
+
+
+## delete
+
+> AsyncOperationResponse delete(distro_base_path, name)
+
+
+
+Try to remove the Namespace if no Collections under Namespace are present.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+
+begin
+  result = api_instance.delete(distro_base_path, name)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedansibleAnsibleNamespaceMetadataResponseList list(distro_base_path, opts)
+
+
+
+Custom exception handler mixin class.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+opts = {
+  company: 'company_example', # String | Filter results where company matches value
+  company__contains: 'company__contains_example', # String | Filter results where company contains value
+  company__icontains: 'company__icontains_example', # String | Filter results where company contains value
+  company__in: ['company__in_example'], # Array<String> | Filter results where company is in a comma-separated list of values
+  company__startswith: 'company__startswith_example', # String | Filter results where company starts with value
+  limit: 56, # Integer | Number of results to return per page.
+  metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value
+  metadata_sha256__in: ['metadata_sha256__in_example'], # Array<String> | Filter results where metadata_sha256 is in a comma-separated list of values
+  name: 'name_example', # String | Filter results where name matches value
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
+  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.
+}
+
+begin
+  result = api_instance.list(distro_base_path, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **company** | **String**| Filter results where company matches value | [optional] 
+ **company__contains** | **String**| Filter results where company contains value | [optional] 
+ **company__icontains** | **String**| Filter results where company contains value | [optional] 
+ **company__in** | [**Array&lt;String&gt;**](String.md)| Filter results where company is in a comma-separated list of values | [optional] 
+ **company__startswith** | **String**| Filter results where company starts with value | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional] 
+ **metadata_sha256__in** | [**Array&lt;String&gt;**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [optional] 
+ **name** | **String**| Filter results where name matches value | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [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
+
+[**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(distro_base_path, name, opts)
+
+
+
+Custom exception handler mixin class.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_example' # String | 
+opts = {
+  name: 'name_example', # String | Required named, only accepts lowercase, numbers and underscores.
+  company: 'company_example', # String | Optional namespace company owner.
+  email: 'email_example', # String | Optional namespace contact email.
+  description: 'description_example', # String | Optional short description.
+  resources: 'resources_example', # String | Optional resource page in markdown format.
+  links: PulpAnsibleClient::NamespaceLink.new, # Array<NamespaceLink> | Labeled related links.
+  avatar: File.new('/path/to/file') # File | Optional avatar image for Namespace
+}
+
+begin
+  result = api_instance.partial_update(distro_base_path, name, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **String**|  | 
+ **name** | **String**| Required named, only accepts lowercase, numbers and underscores. | [optional] 
+ **company** | **String**| Optional namespace company owner. | [optional] 
+ **email** | **String**| Optional namespace contact email. | [optional] 
+ **description** | **String**| Optional short description. | [optional] 
+ **resources** | **String**| Optional resource page in markdown format. | [optional] 
+ **links** | [**Array&lt;NamespaceLink&gt;**](NamespaceLink.md)| Labeled related links. | [optional] 
+ **avatar** | **File**| Optional avatar image for Namespace | [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
+
+
+## read
+
+> AnsibleAnsibleNamespaceMetadataResponse read(distro_base_path, name, opts)
+
+
+
+Custom exception handler mixin class.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi.new
+distro_base_path = 'distro_base_path_example' # String | 
+name = 'name_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.
+}
+
+begin
+  result = api_instance.read(distro_base_path, name, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleContentNamespacesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distro_base_path** | **String**|  | 
+ **name** | **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
+
+[**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md

@@ -0,0 +1,164 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ | 
+[**rebuild**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#rebuild) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ | 
+
+
+
+## list
+
+> PaginatedCollectionVersionSearchListResponseList list(opts)
+
+
+
+A viewset for cross-repo searches.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.new
+opts = {
+  dependency: 'dependency_example', # String | 
+  deprecated: true, # Boolean | 
+  distribution: ['distribution_example'], # Array<String> | Filter collectionversions that are in these distrubtion ids.
+  distribution_base_path: ['distribution_base_path_example'], # Array<String> | Filter collectionversions that are in these base paths.
+  highest: true, # Boolean | 
+  is_deprecated: true, # Boolean | 
+  is_highest: true, # Boolean | 
+  is_signed: true, # Boolean | 
+  keywords: 'keywords_example', # String | 
+  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.
+  order_by: ['order_by_example'], # Array<String> | Ordering
+  q: 'q_example', # String | 
+  repository: ['repository_example'], # Array<String> | Filter collectionversions that are in these repository ids.
+  repository_label: 'repository_label_example', # String | Filter labels by search string
+  repository_name: ['repository_name_example'], # Array<String> | Filter collectionversions that are in these repositories.
+  repository_version: 'repository_version_example', # String | 
+  signed: true, # Boolean | 
+  tags: 'tags_example', # String | Filter by comma separate list of tags that must all be matched
+  version: 'version_example', # String | 
+  version_range: 'version_range_example', # String | 
+  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.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **dependency** | **String**|  | [optional] 
+ **deprecated** | **Boolean**|  | [optional] 
+ **distribution** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these distrubtion ids. | [optional] 
+ **distribution_base_path** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these base paths. | [optional] 
+ **highest** | **Boolean**|  | [optional] 
+ **is_deprecated** | **Boolean**|  | [optional] 
+ **is_highest** | **Boolean**|  | [optional] 
+ **is_signed** | **Boolean**|  | [optional] 
+ **keywords** | **String**|  | [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] 
+ **order_by** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
+ **q** | **String**|  | [optional] 
+ **repository** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these repository ids. | [optional] 
+ **repository_label** | **String**| Filter labels by search string | [optional] 
+ **repository_name** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these repositories. | [optional] 
+ **repository_version** | **String**|  | [optional] 
+ **signed** | **Boolean**|  | [optional] 
+ **tags** | **String**| Filter by comma separate list of tags that must all be matched | [optional] 
+ **version** | **String**|  | [optional] 
+ **version_range** | **String**|  | [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
+
+[**PaginatedCollectionVersionSearchListResponseList**](PaginatedCollectionVersionSearchListResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rebuild
+
+> CollectionVersionSearchListResponse rebuild(collection_version_search_list)
+
+
+
+A viewset for cross-repo searches.
+
+### 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::PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.new
+collection_version_search_list = PulpAnsibleClient::CollectionVersionSearchList.new # CollectionVersionSearchList | 
+
+begin
+  result = api_instance.rebuild(collection_version_search_list)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->rebuild: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **collection_version_search_list** | [**CollectionVersionSearchList**](CollectionVersionSearchList.md)|  | 
+
+### Return type
+
+[**CollectionVersionSearchListResponse**](CollectionVersionSearchListResponse.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/PulpAnsibleTagsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleTagsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------