docs/RepositoriesAnsibleApi.md in pulp_ansible_client-0.19.0 vs docs/RepositoriesAnsibleApi.md in pulp_ansible_client-0.20.0

- old
+ new

@@ -1,38 +1,40 @@ # PulpAnsibleClient::RepositoriesAnsibleApi -All URIs are relative to *https://pulp* +All URIs are relative to *http://pulp* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_role**](RepositoriesAnsibleApi.md#add_role) | **POST** {ansible_ansible_repository_href}add_role/ | +[**add_role**](RepositoriesAnsibleApi.md#add_role) | **POST** {ansible_ansible_repository_href}add_role/ | Add a role [**copy_collection_version**](RepositoriesAnsibleApi.md#copy_collection_version) | **POST** {ansible_ansible_repository_href}copy_collection_version/ | [**create**](RepositoriesAnsibleApi.md#create) | **POST** /pulp/api/v3/repositories/ansible/ansible/ | Create an ansible repository [**delete**](RepositoriesAnsibleApi.md#delete) | **DELETE** {ansible_ansible_repository_href} | Delete an ansible repository [**list**](RepositoriesAnsibleApi.md#list) | **GET** /pulp/api/v3/repositories/ansible/ansible/ | List ansible repositorys -[**list_roles**](RepositoriesAnsibleApi.md#list_roles) | **GET** {ansible_ansible_repository_href}list_roles/ | +[**list_roles**](RepositoriesAnsibleApi.md#list_roles) | **GET** {ansible_ansible_repository_href}list_roles/ | List roles [**mark**](RepositoriesAnsibleApi.md#mark) | **POST** {ansible_ansible_repository_href}mark/ | [**modify**](RepositoriesAnsibleApi.md#modify) | **POST** {ansible_ansible_repository_href}modify/ | Modify Repository Content [**move_collection_version**](RepositoriesAnsibleApi.md#move_collection_version) | **POST** {ansible_ansible_repository_href}move_collection_version/ | -[**my_permissions**](RepositoriesAnsibleApi.md#my_permissions) | **GET** {ansible_ansible_repository_href}my_permissions/ | +[**my_permissions**](RepositoriesAnsibleApi.md#my_permissions) | **GET** {ansible_ansible_repository_href}my_permissions/ | List user permissions [**partial_update**](RepositoriesAnsibleApi.md#partial_update) | **PATCH** {ansible_ansible_repository_href} | Update an ansible repository [**read**](RepositoriesAnsibleApi.md#read) | **GET** {ansible_ansible_repository_href} | Inspect an ansible repository [**rebuild_metadata**](RepositoriesAnsibleApi.md#rebuild_metadata) | **POST** {ansible_ansible_repository_href}rebuild_metadata/ | -[**remove_role**](RepositoriesAnsibleApi.md#remove_role) | **POST** {ansible_ansible_repository_href}remove_role/ | +[**remove_role**](RepositoriesAnsibleApi.md#remove_role) | **POST** {ansible_ansible_repository_href}remove_role/ | Remove a role +[**set_label**](RepositoriesAnsibleApi.md#set_label) | **POST** {ansible_ansible_repository_href}set_label/ | Set a label [**sign**](RepositoriesAnsibleApi.md#sign) | **POST** {ansible_ansible_repository_href}sign/ | [**sync**](RepositoriesAnsibleApi.md#sync) | **POST** {ansible_ansible_repository_href}sync/ | [**unmark**](RepositoriesAnsibleApi.md#unmark) | **POST** {ansible_ansible_repository_href}unmark/ | +[**unset_label**](RepositoriesAnsibleApi.md#unset_label) | **POST** {ansible_ansible_repository_href}unset_label/ | Unset a label [**update**](RepositoriesAnsibleApi.md#update) | **PUT** {ansible_ansible_repository_href} | Update an ansible repository ## add_role > NestedRoleResponse add_role(ansible_ansible_repository_href, nested_role) +Add a role - Add a role for this object to users/groups. ### Example ```ruby @@ -48,10 +50,11 @@ api_instance = PulpAnsibleClient::RepositoriesAnsibleApi.new ansible_ansible_repository_href = 'ansible_ansible_repository_href_example' # String | nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | begin + #Add a role result = api_instance.add_role(ansible_ansible_repository_href, nested_role) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling RepositoriesAnsibleApi->add_role: #{e}" end @@ -264,17 +267,22 @@ latest_with_content: 'latest_with_content_example', # String | Content Unit referenced by HREF 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) * `description` - Description * `-description` - Description (descending) * `next_version` - Next version * `-next_version` - Next version (descending) * `retain_repo_versions` - Retain repo versions * `-retain_repo_versions` - Retain repo versions (descending) * `user_hidden` - User hidden * `-user_hidden` - User hidden (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. pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string + q: 'q_example', # String | remote: 'remote_example', # String | Foreign Key referenced by HREF retain_repo_versions: 56, # Integer | Filter results where retain_repo_versions matches value retain_repo_versions__gt: 56, # Integer | Filter results where retain_repo_versions is greater than value retain_repo_versions__gte: 56, # Integer | Filter results where retain_repo_versions is greater than or equal to value retain_repo_versions__isnull: true, # Boolean | Filter results where retain_repo_versions has a null value @@ -304,18 +312,23 @@ **latest_with_content** | **String**| Content Unit referenced by HREF | [optional] **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&lt;String&gt;**](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&lt;String&gt;**](String.md)| Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;next_version&#x60; - Next version * &#x60;-next_version&#x60; - Next version (descending) * &#x60;retain_repo_versions&#x60; - Retain repo versions * &#x60;-retain_repo_versions&#x60; - Retain repo versions (descending) * &#x60;user_hidden&#x60; - User hidden * &#x60;-user_hidden&#x60; - User hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] **pulp_label_select** | **String**| Filter labels by search string | [optional] - **remote** | **String**| Foreign Key referenced by HREF | [optional] + **q** | **String**| | [optional] + **remote** | [**String**](.md)| Foreign Key referenced by HREF | [optional] **retain_repo_versions** | **Integer**| Filter results where retain_repo_versions matches value | [optional] **retain_repo_versions__gt** | **Integer**| Filter results where retain_repo_versions is greater than value | [optional] **retain_repo_versions__gte** | **Integer**| Filter results where retain_repo_versions is greater than or equal to value | [optional] **retain_repo_versions__isnull** | **Boolean**| Filter results where retain_repo_versions has a null value | [optional] **retain_repo_versions__lt** | **Integer**| Filter results where retain_repo_versions is less than value | [optional] @@ -342,12 +355,12 @@ ## list_roles > ObjectRolesResponse list_roles(ansible_ansible_repository_href, opts) +List roles - List roles assigned to this object. ### Example ```ruby @@ -366,10 +379,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_ansible_repository_href, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling RepositoriesAnsibleApi->list_roles: #{e}" end @@ -563,12 +577,12 @@ ## my_permissions > MyPermissionsResponse my_permissions(ansible_ansible_repository_href, opts) +List user permissions - List permissions available to the current user on this object. ### Example ```ruby @@ -587,10 +601,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_ansible_repository_href, opts) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling RepositoriesAnsibleApi->my_permissions: #{e}" end @@ -789,12 +804,12 @@ ## remove_role > NestedRoleResponse remove_role(ansible_ansible_repository_href, nested_role) +Remove a role - Remove a role for this object from users/groups. ### Example ```ruby @@ -810,10 +825,11 @@ api_instance = PulpAnsibleClient::RepositoriesAnsibleApi.new ansible_ansible_repository_href = 'ansible_ansible_repository_href_example' # String | nested_role = PulpAnsibleClient::NestedRole.new # NestedRole | begin + #Remove a role result = api_instance.remove_role(ansible_ansible_repository_href, nested_role) p result rescue PulpAnsibleClient::ApiError => e puts "Exception when calling RepositoriesAnsibleApi->remove_role: #{e}" end @@ -839,10 +855,65 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json +## set_label + +> SetLabelResponse set_label(ansible_ansible_repository_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::RepositoriesAnsibleApi.new +ansible_ansible_repository_href = 'ansible_ansible_repository_href_example' # String | +set_label = PulpAnsibleClient::SetLabel.new # SetLabel | + +begin + #Set a label + result = api_instance.set_label(ansible_ansible_repository_href, set_label) + p result +rescue PulpAnsibleClient::ApiError => e + puts "Exception when calling RepositoriesAnsibleApi->set_label: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ansible_ansible_repository_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 + + ## sign > AsyncOperationResponse sign(ansible_ansible_repository_href, ansible_repository_signature) @@ -990,9 +1061,64 @@ **ansible_repository_mark** | [**AnsibleRepositoryMark**](AnsibleRepositoryMark.md)| | ### 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 + + +## unset_label + +> UnsetLabelResponse unset_label(ansible_ansible_repository_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::RepositoriesAnsibleApi.new +ansible_ansible_repository_href = 'ansible_ansible_repository_href_example' # String | +unset_label = PulpAnsibleClient::UnsetLabel.new # UnsetLabel | + +begin + #Unset a label + result = api_instance.unset_label(ansible_ansible_repository_href, unset_label) + p result +rescue PulpAnsibleClient::ApiError => e + puts "Exception when calling RepositoriesAnsibleApi->unset_label: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ansible_ansible_repository_href** | **String**| | + **unset_label** | [**UnsetLabel**](UnsetLabel.md)| | + +### Return type + +[**UnsetLabelResponse**](UnsetLabelResponse.md) ### Authorization [basicAuth](../README.md#basicAuth)