docs/PublicationsFileApi.md in pulp_file_client-3.49.13 vs docs/PublicationsFileApi.md in pulp_file_client-3.49.14
- old
+ new
@@ -1,25 +1,25 @@
# PulpFileClient::PublicationsFileApi
-All URIs are relative to *http://pulp*
+All URIs are relative to *http://localhost:24817*
Method | HTTP request | Description
------------- | ------------- | -------------
-[**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/ | 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 a role
+[**publications_file_file_add_role**](PublicationsFileApi.md#publications_file_file_add_role) | **POST** {file_file_publication_href}add_role/ | Add a role
+[**publications_file_file_create**](PublicationsFileApi.md#publications_file_file_create) | **POST** /pulp/api/v3/publications/file/file/ | Create a file publication
+[**publications_file_file_delete**](PublicationsFileApi.md#publications_file_file_delete) | **DELETE** {file_file_publication_href} | Delete a file publication
+[**publications_file_file_list**](PublicationsFileApi.md#publications_file_file_list) | **GET** /pulp/api/v3/publications/file/file/ | List file publications
+[**publications_file_file_list_roles**](PublicationsFileApi.md#publications_file_file_list_roles) | **GET** {file_file_publication_href}list_roles/ | List roles
+[**publications_file_file_my_permissions**](PublicationsFileApi.md#publications_file_file_my_permissions) | **GET** {file_file_publication_href}my_permissions/ | List user permissions
+[**publications_file_file_read**](PublicationsFileApi.md#publications_file_file_read) | **GET** {file_file_publication_href} | Inspect a file publication
+[**publications_file_file_remove_role**](PublicationsFileApi.md#publications_file_file_remove_role) | **POST** {file_file_publication_href}remove_role/ | Remove a role
-## add_role
+## publications_file_file_add_role
-> NestedRoleResponse add_role(file_file_publication_href, nested_role)
+> NestedRoleResponse publications_file_file_add_role(file_file_publication_href, nested_role)
Add a role
Add a role for this object to users/groups.
@@ -39,14 +39,14 @@
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)
+ result = api_instance.publications_file_file_add_role(file_file_publication_href, nested_role)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->add_role: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_add_role: #{e}"
end
```
### Parameters
@@ -68,13 +68,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## create
+## publications_file_file_create
-> AsyncOperationResponse create(file_file_publication)
+> AsyncOperationResponse publications_file_file_create(file_file_publication)
Create a file publication
Trigger an asynchronous task to publish file content.
@@ -93,14 +93,14 @@
api_instance = PulpFileClient::PublicationsFileApi.new
file_file_publication = PulpFileClient::FileFilePublication.new # FileFilePublication |
begin
#Create a file publication
- result = api_instance.create(file_file_publication)
+ result = api_instance.publications_file_file_create(file_file_publication)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->create: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_create: #{e}"
end
```
### Parameters
@@ -121,13 +121,13 @@
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
- **Accept**: application/json
-## delete
+## publications_file_file_delete
-> delete(file_file_publication_href)
+> publications_file_file_delete(file_file_publication_href)
Delete a file publication
A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.
@@ -146,13 +146,13 @@
api_instance = PulpFileClient::PublicationsFileApi.new
file_file_publication_href = 'file_file_publication_href_example' # String |
begin
#Delete a file publication
- api_instance.delete(file_file_publication_href)
+ api_instance.publications_file_file_delete(file_file_publication_href)
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->delete: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_delete: #{e}"
end
```
### Parameters
@@ -173,13 +173,13 @@
- **Content-Type**: Not defined
- **Accept**: Not defined
-## list
+## publications_file_file_list
-> PaginatedfileFilePublicationResponseList list(opts)
+> PaginatedfileFilePublicationResponseList publications_file_file_list(opts)
List file publications
A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.
@@ -217,14 +217,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#List file publications
- result = api_instance.list(opts)
+ result = api_instance.publications_file_file_list(opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->list: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_list: #{e}"
end
```
### Parameters
@@ -262,13 +262,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## list_roles
+## publications_file_file_list_roles
-> ObjectRolesResponse list_roles(file_file_publication_href, opts)
+> ObjectRolesResponse publications_file_file_list_roles(file_file_publication_href, opts)
List roles
List roles assigned to this object.
@@ -291,14 +291,14 @@
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)
+ result = api_instance.publications_file_file_list_roles(file_file_publication_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->list_roles: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_list_roles: #{e}"
end
```
### Parameters
@@ -321,13 +321,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## my_permissions
+## publications_file_file_my_permissions
-> MyPermissionsResponse my_permissions(file_file_publication_href, opts)
+> MyPermissionsResponse publications_file_file_my_permissions(file_file_publication_href, opts)
List user permissions
List permissions available to the current user on this object.
@@ -350,14 +350,14 @@
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)
+ result = api_instance.publications_file_file_my_permissions(file_file_publication_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->my_permissions: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_my_permissions: #{e}"
end
```
### Parameters
@@ -380,13 +380,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## read
+## publications_file_file_read
-> FileFilePublicationResponse read(file_file_publication_href, opts)
+> FileFilePublicationResponse publications_file_file_read(file_file_publication_href, opts)
Inspect a file publication
A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API.
@@ -409,14 +409,14 @@
exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
}
begin
#Inspect a file publication
- result = api_instance.read(file_file_publication_href, opts)
+ result = api_instance.publications_file_file_read(file_file_publication_href, opts)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->read: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_read: #{e}"
end
```
### Parameters
@@ -439,13 +439,13 @@
- **Content-Type**: Not defined
- **Accept**: application/json
-## remove_role
+## publications_file_file_remove_role
-> NestedRoleResponse remove_role(file_file_publication_href, nested_role)
+> NestedRoleResponse publications_file_file_remove_role(file_file_publication_href, nested_role)
Remove a role
Remove a role for this object from users/groups.
@@ -465,13 +465,13 @@
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)
+ result = api_instance.publications_file_file_remove_role(file_file_publication_href, nested_role)
p result
rescue PulpFileClient::ApiError => e
- puts "Exception when calling PublicationsFileApi->remove_role: #{e}"
+ puts "Exception when calling PublicationsFileApi->publications_file_file_remove_role: #{e}"
end
```
### Parameters