docs/AcsFileApi.md in pulp_file_client-3.55.2 vs docs/AcsFileApi.md in pulp_file_client-3.55.3
- old
+ new
@@ -2,27 +2,27 @@
All URIs are relative to *http://localhost:24817*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**acs_file_file_add_role**](AcsFileApi.md#acs_file_file_add_role) | **POST** {file_file_alternate_content_source_href}add_role/ | Add a role
-[**acs_file_file_create**](AcsFileApi.md#acs_file_file_create) | **POST** /pulp/api/v3/acs/file/file/ | Create a file alternate content source
-[**acs_file_file_delete**](AcsFileApi.md#acs_file_file_delete) | **DELETE** {file_file_alternate_content_source_href} | Delete a file alternate content source
-[**acs_file_file_list**](AcsFileApi.md#acs_file_file_list) | **GET** /pulp/api/v3/acs/file/file/ | List file alternate content sources
-[**acs_file_file_list_roles**](AcsFileApi.md#acs_file_file_list_roles) | **GET** {file_file_alternate_content_source_href}list_roles/ | List roles
-[**acs_file_file_my_permissions**](AcsFileApi.md#acs_file_file_my_permissions) | **GET** {file_file_alternate_content_source_href}my_permissions/ | List user permissions
-[**acs_file_file_partial_update**](AcsFileApi.md#acs_file_file_partial_update) | **PATCH** {file_file_alternate_content_source_href} | Update a file alternate content source
-[**acs_file_file_read**](AcsFileApi.md#acs_file_file_read) | **GET** {file_file_alternate_content_source_href} | Inspect a file alternate content source
-[**acs_file_file_refresh**](AcsFileApi.md#acs_file_file_refresh) | **POST** {file_file_alternate_content_source_href}refresh/ | Refresh metadata
-[**acs_file_file_remove_role**](AcsFileApi.md#acs_file_file_remove_role) | **POST** {file_file_alternate_content_source_href}remove_role/ | Remove a role
-[**acs_file_file_update**](AcsFileApi.md#acs_file_file_update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
+[**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/ | 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 a role
+[**update**](AcsFileApi.md#update) | **PUT** {file_file_alternate_content_source_href} | Update a file alternate content source
-## acs_file_file_add_role
+## add_role
-> NestedRoleResponse acs_file_file_add_role(file_file_alternate_content_source_href, nested_role)
+> NestedRoleResponse add_role(file_file_alternate_content_source_href, nested_role)
Add a role
Add a role for this object to users/groups.
@@ -42,14 +42,14 @@
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.acs_file_file_add_role(file_file_alternate_content_source_href, nested_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->acs_file_file_add_role: #{e}"
+ puts "Exception when calling AcsFileApi->add_role: #{e}"
end
```
### Parameters
@@ -71,13 +71,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## acs_file_file_create
+## create
-> FileFileAlternateContentSourceResponse acs_file_file_create(file_file_alternate_content_source)
+> FileFileAlternateContentSourceResponse create(file_file_alternate_content_source)
Create a file alternate content source
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
@@ -96,14 +96,14 @@
api_instance = PulpFileClient::AcsFileApi.new
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
begin
#Create a file alternate content source
- result = api_instance.acs_file_file_create(file_file_alternate_content_source)
+ result = api_instance.create(file_file_alternate_content_source)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_create: #{e}"
+ puts "Exception when calling AcsFileApi->create: #{e}"
end
```
### Parameters
@@ -124,13 +124,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## acs_file_file_delete
+## delete
-> AsyncOperationResponse acs_file_file_delete(file_file_alternate_content_source_href)
+> AsyncOperationResponse delete(file_file_alternate_content_source_href)
Delete a file alternate content source
Trigger an asynchronous delete ACS task
@@ -149,14 +149,14 @@
api_instance = PulpFileClient::AcsFileApi.new
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
begin
#Delete a file alternate content source
- result = api_instance.acs_file_file_delete(file_file_alternate_content_source_href)
+ result = api_instance.delete(file_file_alternate_content_source_href)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_delete: #{e}"
+ puts "Exception when calling AcsFileApi->delete: #{e}"
end
```
### Parameters
@@ -177,13 +177,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_list
+## list
-> PaginatedfileFileAlternateContentSourceResponseList acs_file_file_list(opts)
+> PaginatedfileFileAlternateContentSourceResponseList list(opts)
List file alternate content sources
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
@@ -220,14 +220,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#List file alternate content sources
- result = api_instance.acs_file_file_list(opts)
+ result = api_instance.list(opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_list: #{e}"
+ puts "Exception when calling AcsFileApi->list: #{e}"
end
```
### Parameters
@@ -264,13 +264,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_list_roles
+## list_roles
-> ObjectRolesResponse acs_file_file_list_roles(file_file_alternate_content_source_href, opts)
+> ObjectRolesResponse list_roles(file_file_alternate_content_source_href, opts)
List roles
List roles assigned to this object.
@@ -293,14 +293,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#List roles
- result = api_instance.acs_file_file_list_roles(file_file_alternate_content_source_href, opts)
+ result = api_instance.list_roles(file_file_alternate_content_source_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_list_roles: #{e}"
+ puts "Exception when calling AcsFileApi->list_roles: #{e}"
end
```
### Parameters
@@ -323,13 +323,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_my_permissions
+## my_permissions
-> MyPermissionsResponse acs_file_file_my_permissions(file_file_alternate_content_source_href, opts)
+> MyPermissionsResponse my_permissions(file_file_alternate_content_source_href, opts)
List user permissions
List permissions available to the current user on this object.
@@ -352,14 +352,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#List user permissions
- result = api_instance.acs_file_file_my_permissions(file_file_alternate_content_source_href, opts)
+ result = api_instance.my_permissions(file_file_alternate_content_source_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_my_permissions: #{e}"
+ puts "Exception when calling AcsFileApi->my_permissions: #{e}"
end
```
### Parameters
@@ -382,13 +382,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_partial_update
+## partial_update
-> AsyncOperationResponse acs_file_file_partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
+> AsyncOperationResponse partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
Update a file alternate content source
Trigger an asynchronous partial update task
@@ -408,14 +408,14 @@
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
patchedfile_file_alternate_content_source = PulpFileClient::PatchedfileFileAlternateContentSource.new # PatchedfileFileAlternateContentSource |
begin
#Update a file alternate content source
- result = api_instance.acs_file_file_partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
+ result = api_instance.partial_update(file_file_alternate_content_source_href, patchedfile_file_alternate_content_source)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_partial_update: #{e}"
+ puts "Exception when calling AcsFileApi->partial_update: #{e}"
end
```
### Parameters
@@ -437,13 +437,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## acs_file_file_read
+## read
-> FileFileAlternateContentSourceResponse acs_file_file_read(file_file_alternate_content_source_href, opts)
+> FileFileAlternateContentSourceResponse read(file_file_alternate_content_source_href, opts)
Inspect a file alternate content source
Alternate Content Source ViewSet for File ACS support is provided as a tech preview in pulp_file.
@@ -466,14 +466,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#Inspect a file alternate content source
- result = api_instance.acs_file_file_read(file_file_alternate_content_source_href, opts)
+ result = api_instance.read(file_file_alternate_content_source_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_read: #{e}"
+ puts "Exception when calling AcsFileApi->read: #{e}"
end
```
### Parameters
@@ -496,13 +496,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_refresh
+## refresh
-> TaskGroupOperationResponse acs_file_file_refresh(file_file_alternate_content_source_href)
+> TaskGroupOperationResponse refresh(file_file_alternate_content_source_href)
Refresh metadata
Trigger an asynchronous task to create Alternate Content Source content.
@@ -521,14 +521,14 @@
api_instance = PulpFileClient::AcsFileApi.new
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
begin
#Refresh metadata
- result = api_instance.acs_file_file_refresh(file_file_alternate_content_source_href)
+ result = api_instance.refresh(file_file_alternate_content_source_href)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_refresh: #{e}"
+ puts "Exception when calling AcsFileApi->refresh: #{e}"
end
```
### Parameters
@@ -549,13 +549,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## acs_file_file_remove_role
+## remove_role
-> NestedRoleResponse acs_file_file_remove_role(file_file_alternate_content_source_href, nested_role)
+> NestedRoleResponse remove_role(file_file_alternate_content_source_href, nested_role)
Remove a role
Remove a role for this object from users/groups.
@@ -575,14 +575,14 @@
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.acs_file_file_remove_role(file_file_alternate_content_source_href, nested_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->acs_file_file_remove_role: #{e}"
+ puts "Exception when calling AcsFileApi->remove_role: #{e}"
end
```
### Parameters
@@ -604,13 +604,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## acs_file_file_update
+## update
-> AsyncOperationResponse acs_file_file_update(file_file_alternate_content_source_href, file_file_alternate_content_source)
+> AsyncOperationResponse update(file_file_alternate_content_source_href, file_file_alternate_content_source)
Update a file alternate content source
Trigger an asynchronous update task
@@ -630,13 +630,13 @@
file_file_alternate_content_source_href = 'file_file_alternate_content_source_href_example' # String |
file_file_alternate_content_source = PulpFileClient::FileFileAlternateContentSource.new # FileFileAlternateContentSource |
begin
#Update a file alternate content source
- result = api_instance.acs_file_file_update(file_file_alternate_content_source_href, file_file_alternate_content_source)
+ result = api_instance.update(file_file_alternate_content_source_href, file_file_alternate_content_source)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling AcsFileApi->acs_file_file_update: #{e}"
+ puts "Exception when calling AcsFileApi->update: #{e}"
end
```
### Parameters