pulp_file_client 1.10.5 → 1.11.0

data/docs/RepositoriesFileApi.md

@@ -4,17 +4,75 @@ All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
+[**add_role**](RepositoriesFileApi.md#add_role) | **POST** {file_file_repository_href}add_role/ | 
 [**create**](RepositoriesFileApi.md#create) | **POST** /pulp/api/v3/repositories/file/file/ | Create a file repository
 [**delete**](RepositoriesFileApi.md#delete) | **DELETE** {file_file_repository_href} | Delete a file repository
 [**list**](RepositoriesFileApi.md#list) | **GET** /pulp/api/v3/repositories/file/file/ | List file repositorys
+[**list_roles**](RepositoriesFileApi.md#list_roles) | **GET** {file_file_repository_href}list_roles/ | 
 [**modify**](RepositoriesFileApi.md#modify) | **POST** {file_file_repository_href}modify/ | Modify Repository Content
+[**my_permissions**](RepositoriesFileApi.md#my_permissions) | **GET** {file_file_repository_href}my_permissions/ | 
 [**partial_update**](RepositoriesFileApi.md#partial_update) | **PATCH** {file_file_repository_href} | Update a file repository
 [**read**](RepositoriesFileApi.md#read) | **GET** {file_file_repository_href} | Inspect a file repository
-[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_file_repository_href}sync/ | 
+[**remove_role**](RepositoriesFileApi.md#remove_role) | **POST** {file_file_repository_href}remove_role/ | 
+[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_file_repository_href}sync/ | Sync from a remote
 [**update**](RepositoriesFileApi.md#update) | **PUT** {file_file_repository_href} | Update a file repository
 
 
 
+## add_role
+
+> NestedRoleResponse add_role(file_file_repository_href, nested_role)
+
+
+
+Add a role for this object to users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RepositoriesFileApi.new
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.add_role(file_file_repository_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RepositoriesFileApi->add_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_repository_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
 
 > FileFileRepositoryResponse create(file_file_repository)
@@ -150,7 +208,7 @@ opts = {
   name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
   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', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -177,7 +235,7 @@ Name | Type | Description  | Notes
  **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [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** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_label_select** | **String**| Filter labels by search string | [optional] 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
@@ -196,6 +254,64 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_roles
+
+> ObjectRolesResponse list_roles(file_file_repository_href, opts)
+
+
+
+List roles assigned to this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RepositoriesFileApi.new
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.list_roles(file_file_repository_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RepositoriesFileApi->list_roles: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_repository_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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
+
+
 ## modify
 
 > AsyncOperationResponse modify(file_file_repository_href, repository_add_remove_content)
@@ -251,6 +367,64 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## my_permissions
+
+> MyPermissionsResponse my_permissions(file_file_repository_href, opts)
+
+
+
+List permissions available to the current user on this object.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RepositoriesFileApi.new
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.my_permissions(file_file_repository_href, opts)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RepositoriesFileApi->my_permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_repository_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| 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(file_file_repository_href, patchedfile_file_repository)
@@ -365,11 +539,65 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## remove_role
+
+> NestedRoleResponse remove_role(file_file_repository_href, nested_role)
+
+
+
+Remove a role for this object from users/groups.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_file_client'
+# setup authorization
+PulpFileClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpFileClient::RepositoriesFileApi.new
+file_file_repository_href = 'file_file_repository_href_example' # String | 
+nested_role = PulpFileClient::NestedRole.new # NestedRole | 
+
+begin
+  result = api_instance.remove_role(file_file_repository_href, nested_role)
+  p result
+rescue PulpFileClient::ApiError => e
+  puts "Exception when calling RepositoriesFileApi->remove_role: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **file_file_repository_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
+
+
 ## sync
 
 > AsyncOperationResponse sync(file_file_repository_href, repository_sync_url)
 
-
+Sync from a remote
 
 Trigger an asynchronous task to sync file content.
 
@@ -390,6 +618,7 @@ file_file_repository_href = 'file_file_repository_href_example' # String |
 repository_sync_url = PulpFileClient::RepositorySyncURL.new # RepositorySyncURL | 
 
 begin
+  #Sync from a remote
   result = api_instance.sync(file_file_repository_href, repository_sync_url)
   p result
 rescue PulpFileClient::ApiError => e

data/docs/RepositoriesFileVersionsApi.md

@@ -97,7 +97,7 @@ opts = {
   number__lte: 56, # Integer | Filter results where number is less than or equal to value
   number__range: [56], # Array<Integer> | Filter results where number is between two comma separated values
   offset: 56, # Integer | The initial index from which to return the results.
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  ordering: ['ordering_example'], # Array<String> | Ordering
   pulp_created: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
   pulp_created__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than value
   pulp_created__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_created is greater than or equal to value
@@ -133,7 +133,7 @@ Name | Type | Description  | Notes
  **number__lte** | **Integer**| Filter results where number is less than or equal to value | [optional] 
  **number__range** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where number is between two comma separated values | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering | [optional] 
  **pulp_created** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
  **pulp_created__gt** | **DateTime**| Filter results where pulp_created is greater than value | [optional] 
  **pulp_created__gte** | **DateTime**| Filter results where pulp_created is greater than or equal to value | [optional] 
@@ -218,7 +218,7 @@ Name | Type | Description  | Notes
 
 ## repair
 
-> AsyncOperationResponse repair(file_file_repository_version_href, repository_version)
+> AsyncOperationResponse repair(file_file_repository_version_href, repair)
 
 
 
@@ -238,10 +238,10 @@ end
 
 api_instance = PulpFileClient::RepositoriesFileVersionsApi.new
 file_file_repository_version_href = 'file_file_repository_version_href_example' # String | 
-repository_version = PulpFileClient::RepositoryVersion.new # RepositoryVersion | 
+repair = PulpFileClient::Repair.new # Repair | 
 
 begin
-  result = api_instance.repair(file_file_repository_version_href, repository_version)
+  result = api_instance.repair(file_file_repository_version_href, repair)
   p result
 rescue PulpFileClient::ApiError => e
   puts "Exception when calling RepositoriesFileVersionsApi->repair: #{e}"
@@ -254,7 +254,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **file_file_repository_version_href** | **String**|  | 
- **repository_version** | [**RepositoryVersion**](RepositoryVersion.md)|  | 
+ **repair** | [**Repair**](Repair.md)|  | 
 
 ### Return type