PublicationsFileApi.md in pulp_file_client-1.14.5

- old
+ new

@@ -1,28 +1,28 @@
 # PulpFileClient::PublicationsFileApi
 
-All URIs are relative to *https://pulp*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ | 
+[**add_role**](PublicationsFileApi.md#add_role) | **POST** {file_file_publication_href}add_role/ | Add a role
 [**create**](PublicationsFileApi.md#create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
 [**delete**](PublicationsFileApi.md#delete) | **DELETE** {file_file_publication_href} | Delete a file publication
 [**list**](PublicationsFileApi.md#list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
-[**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ | 
-[**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ | 
+[**list_roles**](PublicationsFileApi.md#list_roles) | **GET** {file_file_publication_href}list_roles/ | List roles
+[**my_permissions**](PublicationsFileApi.md#my_permissions) | **GET** {file_file_publication_href}my_permissions/ | List user permissions
 [**read**](PublicationsFileApi.md#read) | **GET** {file_file_publication_href} | Inspect a file publication
-[**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ | 
+[**remove_role**](PublicationsFileApi.md#remove_role) | **POST** {file_file_publication_href}remove_role/ | Remove a role
 
 
 
 ## add_role
 
 > NestedRoleResponse add_role(file_file_publication_href, nested_role)
 
+Add a role
 
-
 Add a role for this object to users/groups.
 
 ### Example
 
 ```ruby
@@ -38,10 +38,11 @@
 api_instance = PulpFileClient::PublicationsFileApi.new
 file_file_publication_href = 'file_file_publication_href_example' # String | 
 nested_role = PulpFileClient::NestedRole.new # NestedRole | 
 
 begin
+  #Add a role
   result = api_instance.add_role(file_file_publication_href, nested_role)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling PublicationsFileApi->add_role: #{e}"
 end
@@ -207,10 +208,11 @@
   pulp_created__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than value
   pulp_created__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is less than or equal to value
   pulp_created__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_created is between two comma separated values
   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 | 
   repository: 'repository_example', # String | Repository referenced by HREF
   repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
   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.
 }
@@ -240,10 +242,11 @@
  **pulp_created__lt** | **DateTime**| Filter results where pulp_created is less than value | [optional] 
  **pulp_created__lte** | **DateTime**| Filter results where pulp_created is less than or equal to value | [optional] 
  **pulp_created__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_created is between two comma separated values | [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] 
  **repository** | **String**| Repository referenced by HREF | [optional] 
  **repository_version** | [**String**](.md)| Repository Version referenced by HREF | [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] 
 
@@ -263,12 +266,12 @@
 
 ## list_roles
 
 > ObjectRolesResponse list_roles(file_file_publication_href, opts)
 
+List roles
 
-
 List roles assigned to this object.
 
 ### Example
 
 ```ruby
@@ -287,10 +290,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_publication_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling PublicationsFileApi->list_roles: #{e}"
 end
@@ -321,12 +325,12 @@
 
 ## my_permissions
 
 > MyPermissionsResponse my_permissions(file_file_publication_href, opts)
 
+List user permissions
 
-
 List permissions available to the current user on this object.
 
 ### Example
 
 ```ruby
@@ -345,10 +349,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_publication_href, opts)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling PublicationsFileApi->my_permissions: #{e}"
 end
@@ -438,12 +443,12 @@
 
 ## remove_role
 
 > NestedRoleResponse remove_role(file_file_publication_href, nested_role)
 
+Remove a role
 
-
 Remove a role for this object from users/groups.
 
 ### Example
 
 ```ruby
@@ -459,9 +464,10 @@
 api_instance = PulpFileClient::PublicationsFileApi.new
 file_file_publication_href = 'file_file_publication_href_example' # String | 
 nested_role = PulpFileClient::NestedRole.new # NestedRole | 
 
 begin
+  #Remove a role
   result = api_instance.remove_role(file_file_publication_href, nested_role)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling PublicationsFileApi->remove_role: #{e}"
 end