pulp_ansible_client 0.16.4 → 0.17.0

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
 ------------- | ------------- | -------------

data/docs/RemotesCollectionApi.md

@@ -1,18 +1,76 @@
 # PulpAnsibleClient::RemotesCollectionApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RemotesCollectionApi.md#add_role) | **POST** {ansible_collection_remote_href}add_role/ | 
 [**create**](RemotesCollectionApi.md#create) | **POST** /pulp/api/v3/remotes/ansible/collection/ | Create a collection remote
 [**delete**](RemotesCollectionApi.md#delete) | **DELETE** {ansible_collection_remote_href} | Delete a collection remote
 [**list**](RemotesCollectionApi.md#list) | **GET** /pulp/api/v3/remotes/ansible/collection/ | List collection remotes
+[**list_roles**](RemotesCollectionApi.md#list_roles) | **GET** {ansible_collection_remote_href}list_roles/ | 
+[**my_permissions**](RemotesCollectionApi.md#my_permissions) | **GET** {ansible_collection_remote_href}my_permissions/ | 
 [**partial_update**](RemotesCollectionApi.md#partial_update) | **PATCH** {ansible_collection_remote_href} | Update a collection remote
 [**read**](RemotesCollectionApi.md#read) | **GET** {ansible_collection_remote_href} | Inspect a collection remote
+[**remove_role**](RemotesCollectionApi.md#remove_role) | **POST** {ansible_collection_remote_href}remove_role/ | 
 [**update**](RemotesCollectionApi.md#update) | **PUT** {ansible_collection_remote_href} | Update a collection remote
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(ansible_collection_remote_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### 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::RemotesCollectionApi.new
+ansible_collection_remote_href = 'ansible_collection_remote_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(ansible_collection_remote_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## create
 
 > AnsibleCollectionRemoteResponse create(ansible_collection_remote)
@@ -156,6 +214,10 @@ opts = {
   pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
   pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
   pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
+  url: 'url_example', # String | Filter results where url matches value
+  url__contains: 'url__contains_example', # String | Filter results where url contains value
+  url__icontains: 'url__icontains_example', # String | Filter results where url contains value
+  url__in: ['url__in_example'], # Array<String> | Filter results where url is in a comma-separated list of values
   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.
 }
@@ -189,6 +251,10 @@ Name | Type | Description  | Notes
  **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional] 
  **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
  **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional] 
+ **url** | **String**| Filter results where url matches value | [optional] 
+ **url__contains** | **String**| Filter results where url contains value | [optional] 
+ **url__icontains** | **String**| Filter results where url contains value | [optional] 
+ **url__in** | [**Array&lt;String&gt;**](String.md)| Filter results where url is in a comma-separated list of values | [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] 
 
@@ -206,6 +272,122 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(ansible_collection_remote_href, opts)
+
+
+
+List roles assigned to this 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::RemotesCollectionApi.new
+ansible_collection_remote_href = 'ansible_collection_remote_href_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.list_roles(ansible_collection_remote_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **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
+
+[**ObjectRolesResponse**](ObjectRolesResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## my_permissions
+
+> MyPermissionsResponse my_permissions(ansible_collection_remote_href, opts)
+
+
+
+List permissions available to the current user on this 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::RemotesCollectionApi.new
+ansible_collection_remote_href = 'ansible_collection_remote_href_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.my_permissions(ansible_collection_remote_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **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
+
+[**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## partial_update
 
 > AsyncOperationResponse partial_update(ansible_collection_remote_href, patchedansible_collection_remote)
@@ -320,6 +502,60 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(ansible_collection_remote_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### 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::RemotesCollectionApi.new
+ansible_collection_remote_href = 'ansible_collection_remote_href_example' # String | 
+nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(ansible_collection_remote_href, nested_role)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling RemotesCollectionApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **String**|  | 
+ **nested_role** | [**NestedRole**](NestedRole.md)|  | 
+
+### Return type
+
+[**NestedRoleResponse**](NestedRoleResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
 ## update
 
 > AsyncOperationResponse update(ansible_collection_remote_href, ansible_collection_remote)