docs/RemotesCollectionApi.md in pulp_ansible_client-0.18.0 vs docs/RemotesCollectionApi.md in pulp_ansible_client-0.18.1
- old
+ new
@@ -1,30 +1,32 @@
# PulpAnsibleClient::RemotesCollectionApi
-All URIs are relative to *https://pulp*
+All URIs are relative to *http://pulp*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**add_role**](RemotesCollectionApi.md#add_role) | **POST** {ansible_collection_remote_href}add_role/ |
+[**add_role**](RemotesCollectionApi.md#add_role) | **POST** {ansible_collection_remote_href}add_role/ | Add a 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/ |
+[**list_roles**](RemotesCollectionApi.md#list_roles) | **GET** {ansible_collection_remote_href}list_roles/ | List roles
+[**my_permissions**](RemotesCollectionApi.md#my_permissions) | **GET** {ansible_collection_remote_href}my_permissions/ | List user 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/ |
+[**remove_role**](RemotesCollectionApi.md#remove_role) | **POST** {ansible_collection_remote_href}remove_role/ | Remove a role
+[**set_label**](RemotesCollectionApi.md#set_label) | **POST** {ansible_collection_remote_href}set_label/ | Set a label
+[**unset_label**](RemotesCollectionApi.md#unset_label) | **POST** {ansible_collection_remote_href}unset_label/ | Unset a label
[**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
-
Add a role for this object to users/groups.
### Example
```ruby
@@ -40,10 +42,11 @@
api_instance = PulpAnsibleClient::RemotesCollectionApi.new
ansible_collection_remote_href = 'ansible_collection_remote_href_example' # String |
nested_role = PulpAnsibleClient::NestedRole.new # NestedRole |
begin
+ #Add a role
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
@@ -201,11 +204,15 @@
opts = {
limit: 56, # Integer | Number of results to return per page.
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__iexact: 'name__iexact_example', # String | Filter results where name matches value
name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+ name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value
+ name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value
+ name__regex: 'name__regex_example', # String | Filter results where name matches regex value
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 * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `requirements_file` - Requirements file * `-requirements_file` - Requirements file (descending) * `auth_url` - Auth url * `-auth_url` - Auth url (descending) * `token` - Token * `-token` - Token (descending) * `sync_dependencies` - Sync dependencies * `-sync_dependencies` - Sync dependencies (descending) * `signed_only` - Signed only * `-signed_only` - Signed only (descending) * `pk` - Pk * `-pk` - Pk (descending)
pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
@@ -214,10 +221,11 @@
pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
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
+ q: 'q_example', # String |
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.
@@ -240,11 +248,15 @@
------------- | ------------- | ------------- | -------------
**limit** | **Integer**| Number of results to return per page. | [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__iexact** | **String**| Filter results where name matches value | [optional]
**name__in** | [**Array<String>**](String.md)| Filter results where name is in a comma-separated list of values | [optional]
+ **name__iregex** | **String**| Filter results where name matches regex value | [optional]
+ **name__istartswith** | **String**| Filter results where name starts with value | [optional]
+ **name__regex** | **String**| Filter results where name matches regex value | [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<String>**](String.md)| Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `url` - Url * `-url` - Url (descending) * `ca_cert` - Ca cert * `-ca_cert` - Ca cert (descending) * `client_cert` - Client cert * `-client_cert` - Client cert (descending) * `client_key` - Client key * `-client_key` - Client key (descending) * `tls_validation` - Tls validation * `-tls_validation` - Tls validation (descending) * `username` - Username * `-username` - Username (descending) * `password` - Password * `-password` - Password (descending) * `proxy_url` - Proxy url * `-proxy_url` - Proxy url (descending) * `proxy_username` - Proxy username * `-proxy_username` - Proxy username (descending) * `proxy_password` - Proxy password * `-proxy_password` - Proxy password (descending) * `download_concurrency` - Download concurrency * `-download_concurrency` - Download concurrency (descending) * `max_retries` - Max retries * `-max_retries` - Max retries (descending) * `policy` - Policy * `-policy` - Policy (descending) * `total_timeout` - Total timeout * `-total_timeout` - Total timeout (descending) * `connect_timeout` - Connect timeout * `-connect_timeout` - Connect timeout (descending) * `sock_connect_timeout` - Sock connect timeout * `-sock_connect_timeout` - Sock connect timeout (descending) * `sock_read_timeout` - Sock read timeout * `-sock_read_timeout` - Sock read timeout (descending) * `headers` - Headers * `-headers` - Headers (descending) * `rate_limit` - Rate limit * `-rate_limit` - Rate limit (descending) * `requirements_file` - Requirements file * `-requirements_file` - Requirements file (descending) * `auth_url` - Auth url * `-auth_url` - Auth url (descending) * `token` - Token * `-token` - Token (descending) * `sync_dependencies` - Sync dependencies * `-sync_dependencies` - Sync dependencies (descending) * `signed_only` - Signed only * `-signed_only` - Signed only (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional]
**pulp_href__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
**pulp_id__in** | [**Array<String>**](String.md)| Multiple values may be separated by commas. | [optional]
@@ -253,10 +265,11 @@
**pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional]
**pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional]
**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<DateTime>**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [optional]
+ **q** | **String**| | [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<String>**](String.md)| Filter results where url is in a comma-separated list of values | [optional]
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
@@ -278,12 +291,12 @@
## list_roles
> ObjectRolesResponse list_roles(ansible_collection_remote_href, opts)
+List roles
-
List roles assigned to this object.
### Example
```ruby
@@ -302,10 +315,11 @@
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
+ #List roles
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
@@ -336,12 +350,12 @@
## my_permissions
> MyPermissionsResponse my_permissions(ansible_collection_remote_href, opts)
+List user permissions
-
List permissions available to the current user on this object.
### Example
```ruby
@@ -360,10 +374,11 @@
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
+ #List user permissions
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
@@ -508,12 +523,12 @@
## remove_role
> NestedRoleResponse remove_role(ansible_collection_remote_href, nested_role)
+Remove a role
-
Remove a role for this object from users/groups.
### Example
```ruby
@@ -529,10 +544,11 @@
api_instance = PulpAnsibleClient::RemotesCollectionApi.new
ansible_collection_remote_href = 'ansible_collection_remote_href_example' # String |
nested_role = PulpAnsibleClient::NestedRole.new # NestedRole |
begin
+ #Remove a role
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
@@ -547,9 +563,119 @@
**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
+
+
+## set_label
+
+> SetLabelResponse set_label(ansible_collection_remote_href, set_label)
+
+Set a label
+
+Set a single pulp_label on the object to a specific value or null.
+
+### 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 |
+set_label = PulpAnsibleClient::SetLabel.new # SetLabel |
+
+begin
+ #Set a label
+ result = api_instance.set_label(ansible_collection_remote_href, set_label)
+ p result
+rescue PulpAnsibleClient::ApiError => e
+ puts "Exception when calling RemotesCollectionApi->set_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **String**| |
+ **set_label** | [**SetLabel**](SetLabel.md)| |
+
+### Return type
+
+[**SetLabelResponse**](SetLabelResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## unset_label
+
+> UnsetLabelResponse unset_label(ansible_collection_remote_href, unset_label)
+
+Unset a label
+
+Unset a single pulp_label on the 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 |
+unset_label = PulpAnsibleClient::UnsetLabel.new # UnsetLabel |
+
+begin
+ #Unset a label
+ result = api_instance.unset_label(ansible_collection_remote_href, unset_label)
+ p result
+rescue PulpAnsibleClient::ApiError => e
+ puts "Exception when calling RemotesCollectionApi->unset_label: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_remote_href** | **String**| |
+ **unset_label** | [**UnsetLabel**](UnsetLabel.md)| |
+
+### Return type
+
+[**UnsetLabelResponse**](UnsetLabelResponse.md)
### Authorization
[basicAuth](../README.md#basicAuth)