docs/AcsFileApi.md in pulp_file_client-1.14.4 vs docs/AcsFileApi.md in pulp_file_client-1.14.5

- old
+ new

@@ -1,31 +1,31 @@ # PulpFileClient::AcsFileApi -All URIs are relative to *https://pulp* +All URIs are relative to *http://pulp* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_role**](AcsFileApi.md#add_role) | **POST** {file_file_alternate_content_source_href}add_role/ | +[**add_role**](AcsFileApi.md#add_role) | **POST** {file_file_alternate_content_source_href}add_role/ | Add a role [**create**](AcsFileApi.md#create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source [**delete**](AcsFileApi.md#delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source [**list**](AcsFileApi.md#list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources -[**list_roles**](AcsFileApi.md#list_roles) | **GET** {file_file_alternate_content_source_href}list_roles/ | -[**my_permissions**](AcsFileApi.md#my_permissions) | **GET** {file_file_alternate_content_source_href}my_permissions/ | +[**list_roles**](AcsFileApi.md#list_roles) | **GET** {file_file_alternate_content_source_href}list_roles/ | List roles +[**my_permissions**](AcsFileApi.md#my_permissions) | **GET** {file_file_alternate_content_source_href}my_permissions/ | List user permissions [**partial_update**](AcsFileApi.md#partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source [**read**](AcsFileApi.md#read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source [**refresh**](AcsFileApi.md#refresh) | **POST** {file_file_alternate_content_source_href}refresh/ | Refresh metadata -[**remove_role**](AcsFileApi.md#remove_role) | **POST** {file_file_alternate_content_source_href}remove_role/ | +[**remove_role**](AcsFileApi.md#remove_role) | **POST** {file_file_alternate_content_source_href}remove_role/ | Remove a role [**update**](AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source ## add_role > NestedRoleResponse add_role(file_file_alternate_content_source_href, nested_role) +Add a role - Add a role for this object to users/groups. ### Example ```ruby @@ -41,10 +41,11 @@ api_instance = PulpFileClient::AcsFileApi.new file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin + #Add a role result = api_instance.add_role(file_file_alternate_content_source_href, nested_role) p result rescue PulpFileClient::ApiError => e puts "Exception when calling AcsFileApi->add_role: #{e}" end @@ -202,16 +203,21 @@ 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) * `last_refreshed` - Last refreshed * `-last_refreshed` - Last refreshed (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. + q: 'q_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 @@ -230,16 +236,21 @@ ------------- | ------------- | ------------- | ------------- **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;last_refreshed&#x60; - Last refreshed * &#x60;-last_refreshed&#x60; - Last refreshed (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] + **q** | **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 @@ -257,12 +268,12 @@ ## list_roles > ObjectRolesResponse list_roles(file_file_alternate_content_source_href, opts) +List roles - List roles assigned to this object. ### Example ```ruby @@ -281,10 +292,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(file_file_alternate_content_source_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling AcsFileApi->list_roles: #{e}" end @@ -315,12 +327,12 @@ ## my_permissions > MyPermissionsResponse my_permissions(file_file_alternate_content_source_href, opts) +List user permissions - List permissions available to the current user on this object. ### Example ```ruby @@ -339,10 +351,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(file_file_alternate_content_source_href, opts) p result rescue PulpFileClient::ApiError => e puts "Exception when calling AcsFileApi->my_permissions: #{e}" end @@ -540,12 +553,12 @@ ## remove_role > NestedRoleResponse remove_role(file_file_alternate_content_source_href, nested_role) +Remove a role - Remove a role for this object from users/groups. ### Example ```ruby @@ -561,9 +574,10 @@ api_instance = PulpFileClient::AcsFileApi.new file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin + #Remove a role result = api_instance.remove_role(file_file_alternate_content_source_href, nested_role) p result rescue PulpFileClient::ApiError => e puts "Exception when calling AcsFileApi->remove_role: #{e}" end