docs/RepositoriesFileApi.md in pulp_file_client-3.55.2 vs docs/RepositoriesFileApi.md in pulp_file_client-3.55.3

- old
+ new

@@ -2,30 +2,30 @@ All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- -[**repositories_file_file_add_role**](RepositoriesFileApi.md#repositories_file_file_add_role) | **POST** {file_file_repository_href}add_role/ | Add a role -[**repositories_file_file_create**](RepositoriesFileApi.md#repositories_file_file_create) | **POST** /pulp/api/v3/repositories/file/file/ | Create a file repository -[**repositories_file_file_delete**](RepositoriesFileApi.md#repositories_file_file_delete) | **DELETE** {file_file_repository_href} | Delete a file repository -[**repositories_file_file_list**](RepositoriesFileApi.md#repositories_file_file_list) | **GET** /pulp/api/v3/repositories/file/file/ | List file repositorys -[**repositories_file_file_list_roles**](RepositoriesFileApi.md#repositories_file_file_list_roles) | **GET** {file_file_repository_href}list_roles/ | List roles -[**repositories_file_file_modify**](RepositoriesFileApi.md#repositories_file_file_modify) | **POST** {file_file_repository_href}modify/ | Modify Repository Content -[**repositories_file_file_my_permissions**](RepositoriesFileApi.md#repositories_file_file_my_permissions) | **GET** {file_file_repository_href}my_permissions/ | List user permissions -[**repositories_file_file_partial_update**](RepositoriesFileApi.md#repositories_file_file_partial_update) | **PATCH** {file_file_repository_href} | Update a file repository -[**repositories_file_file_read**](RepositoriesFileApi.md#repositories_file_file_read) | **GET** {file_file_repository_href} | Inspect a file repository -[**repositories_file_file_remove_role**](RepositoriesFileApi.md#repositories_file_file_remove_role) | **POST** {file_file_repository_href}remove_role/ | Remove a role -[**repositories_file_file_set_label**](RepositoriesFileApi.md#repositories_file_file_set_label) | **POST** {file_file_repository_href}set_label/ | Set a label -[**repositories_file_file_sync**](RepositoriesFileApi.md#repositories_file_file_sync) | **POST** {file_file_repository_href}sync/ | Sync from a remote -[**repositories_file_file_unset_label**](RepositoriesFileApi.md#repositories_file_file_unset_label) | **POST** {file_file_repository_href}unset_label/ | Unset a label -[**repositories_file_file_update**](RepositoriesFileApi.md#repositories_file_file_update) | **PUT** {file_file_repository_href} | Update a file repository +[**add_role**](RepositoriesFileApi.md#add_role) | **POST** {file_file_repository_href}add_role/ | Add a 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/ | 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/ | List user 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 +[**remove_role**](RepositoriesFileApi.md#remove_role) | **POST** {file_file_repository_href}remove_role/ | Remove a role +[**set_label**](RepositoriesFileApi.md#set_label) | **POST** {file_file_repository_href}set_label/ | Set a label +[**sync**](RepositoriesFileApi.md#sync) | **POST** {file_file_repository_href}sync/ | Sync from a remote +[**unset_label**](RepositoriesFileApi.md#unset_label) | **POST** {file_file_repository_href}unset_label/ | Unset a label +[**update**](RepositoriesFileApi.md#update) | **PUT** {file_file_repository_href} | Update a file repository -## repositories_file_file_add_role +## add_role -> NestedRoleResponse repositories_file_file_add_role(file_file_repository_href, nested_role) +> NestedRoleResponse add_role(file_file_repository_href, nested_role) Add a role Add a role for this object to users/groups. @@ -45,14 +45,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin #Add a role - result = api_instance.repositories_file_file_add_role(file_file_repository_href, nested_role) + result = api_instance.add_role(file_file_repository_href, nested_role) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_add_role: #{e}" + puts "Exception when calling RepositoriesFileApi->add_role: #{e}" end ``` ### Parameters @@ -74,13 +74,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_create +## create -> FileFileRepositoryResponse repositories_file_file_create(file_file_repository) +> FileFileRepositoryResponse create(file_file_repository) Create a file repository FileRepository represents a single file repository, to which content can be synced, added, or removed. @@ -99,14 +99,14 @@ api_instance = PulpFileClient::RepositoriesFileApi.new file_file_repository = PulpFileClient::FileFileRepository.new # FileFileRepository | begin #Create a file repository - result = api_instance.repositories_file_file_create(file_file_repository) + result = api_instance.create(file_file_repository) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_create: #{e}" + puts "Exception when calling RepositoriesFileApi->create: #{e}" end ``` ### Parameters @@ -127,13 +127,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_delete +## delete -> AsyncOperationResponse repositories_file_file_delete(file_file_repository_href) +> AsyncOperationResponse delete(file_file_repository_href) Delete a file repository Trigger an asynchronous delete task @@ -152,14 +152,14 @@ api_instance = PulpFileClient::RepositoriesFileApi.new file_file_repository_href = 'file_file_repository_href_example' # String | begin #Delete a file repository - result = api_instance.repositories_file_file_delete(file_file_repository_href) + result = api_instance.delete(file_file_repository_href) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_delete: #{e}" + puts "Exception when calling RepositoriesFileApi->delete: #{e}" end ``` ### Parameters @@ -180,13 +180,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## repositories_file_file_list +## list -> PaginatedfileFileRepositoryResponseList repositories_file_file_list(opts) +> PaginatedfileFileRepositoryResponseList list(opts) List file repositorys FileRepository represents a single file repository, to which content can be synced, added, or removed. @@ -235,14 +235,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List file repositorys - result = api_instance.repositories_file_file_list(opts) + result = api_instance.list(opts) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_list: #{e}" + puts "Exception when calling RepositoriesFileApi->list: #{e}" end ``` ### Parameters @@ -291,13 +291,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## repositories_file_file_list_roles +## list_roles -> ObjectRolesResponse repositories_file_file_list_roles(file_file_repository_href, opts) +> ObjectRolesResponse list_roles(file_file_repository_href, opts) List roles List roles assigned to this object. @@ -320,14 +320,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List roles - result = api_instance.repositories_file_file_list_roles(file_file_repository_href, opts) + result = api_instance.list_roles(file_file_repository_href, opts) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_list_roles: #{e}" + puts "Exception when calling RepositoriesFileApi->list_roles: #{e}" end ``` ### Parameters @@ -350,13 +350,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## repositories_file_file_modify +## modify -> AsyncOperationResponse repositories_file_file_modify(file_file_repository_href, repository_add_remove_content) +> AsyncOperationResponse modify(file_file_repository_href, repository_add_remove_content) Modify Repository Content Trigger an asynchronous task to create a new repository version. @@ -376,14 +376,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | repository_add_remove_content = PulpFileClient::RepositoryAddRemoveContent.new # RepositoryAddRemoveContent | begin #Modify Repository Content - result = api_instance.repositories_file_file_modify(file_file_repository_href, repository_add_remove_content) + result = api_instance.modify(file_file_repository_href, repository_add_remove_content) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_modify: #{e}" + puts "Exception when calling RepositoriesFileApi->modify: #{e}" end ``` ### Parameters @@ -405,13 +405,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_my_permissions +## my_permissions -> MyPermissionsResponse repositories_file_file_my_permissions(file_file_repository_href, opts) +> MyPermissionsResponse my_permissions(file_file_repository_href, opts) List user permissions List permissions available to the current user on this object. @@ -434,14 +434,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List user permissions - result = api_instance.repositories_file_file_my_permissions(file_file_repository_href, opts) + result = api_instance.my_permissions(file_file_repository_href, opts) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_my_permissions: #{e}" + puts "Exception when calling RepositoriesFileApi->my_permissions: #{e}" end ``` ### Parameters @@ -464,13 +464,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## repositories_file_file_partial_update +## partial_update -> AsyncOperationResponse repositories_file_file_partial_update(file_file_repository_href, patchedfile_file_repository) +> AsyncOperationResponse partial_update(file_file_repository_href, patchedfile_file_repository) Update a file repository Trigger an asynchronous partial update task @@ -490,14 +490,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | patchedfile_file_repository = PulpFileClient::PatchedfileFileRepository.new # PatchedfileFileRepository | begin #Update a file repository - result = api_instance.repositories_file_file_partial_update(file_file_repository_href, patchedfile_file_repository) + result = api_instance.partial_update(file_file_repository_href, patchedfile_file_repository) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_partial_update: #{e}" + puts "Exception when calling RepositoriesFileApi->partial_update: #{e}" end ``` ### Parameters @@ -519,13 +519,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_read +## read -> FileFileRepositoryResponse repositories_file_file_read(file_file_repository_href, opts) +> FileFileRepositoryResponse read(file_file_repository_href, opts) Inspect a file repository FileRepository represents a single file repository, to which content can be synced, added, or removed. @@ -548,14 +548,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #Inspect a file repository - result = api_instance.repositories_file_file_read(file_file_repository_href, opts) + result = api_instance.read(file_file_repository_href, opts) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_read: #{e}" + puts "Exception when calling RepositoriesFileApi->read: #{e}" end ``` ### Parameters @@ -578,13 +578,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## repositories_file_file_remove_role +## remove_role -> NestedRoleResponse repositories_file_file_remove_role(file_file_repository_href, nested_role) +> NestedRoleResponse remove_role(file_file_repository_href, nested_role) Remove a role Remove a role for this object from users/groups. @@ -604,14 +604,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | nested_role = PulpFileClient::NestedRole.new # NestedRole | begin #Remove a role - result = api_instance.repositories_file_file_remove_role(file_file_repository_href, nested_role) + result = api_instance.remove_role(file_file_repository_href, nested_role) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_remove_role: #{e}" + puts "Exception when calling RepositoriesFileApi->remove_role: #{e}" end ``` ### Parameters @@ -633,13 +633,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_set_label +## set_label -> SetLabelResponse repositories_file_file_set_label(file_file_repository_href, set_label) +> SetLabelResponse set_label(file_file_repository_href, set_label) Set a label Set a single pulp_label on the object to a specific value or null. @@ -659,14 +659,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | set_label = PulpFileClient::SetLabel.new # SetLabel | begin #Set a label - result = api_instance.repositories_file_file_set_label(file_file_repository_href, set_label) + result = api_instance.set_label(file_file_repository_href, set_label) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_set_label: #{e}" + puts "Exception when calling RepositoriesFileApi->set_label: #{e}" end ``` ### Parameters @@ -688,13 +688,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_sync +## sync -> AsyncOperationResponse repositories_file_file_sync(file_file_repository_href, repository_sync_url) +> AsyncOperationResponse sync(file_file_repository_href, repository_sync_url) Sync from a remote Trigger an asynchronous task to sync file content. @@ -714,14 +714,14 @@ 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.repositories_file_file_sync(file_file_repository_href, repository_sync_url) + result = api_instance.sync(file_file_repository_href, repository_sync_url) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_sync: #{e}" + puts "Exception when calling RepositoriesFileApi->sync: #{e}" end ``` ### Parameters @@ -743,13 +743,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_unset_label +## unset_label -> UnsetLabelResponse repositories_file_file_unset_label(file_file_repository_href, unset_label) +> UnsetLabelResponse unset_label(file_file_repository_href, unset_label) Unset a label Unset a single pulp_label on the object. @@ -769,14 +769,14 @@ file_file_repository_href = 'file_file_repository_href_example' # String | unset_label = PulpFileClient::UnsetLabel.new # UnsetLabel | begin #Unset a label - result = api_instance.repositories_file_file_unset_label(file_file_repository_href, unset_label) + result = api_instance.unset_label(file_file_repository_href, unset_label) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_unset_label: #{e}" + puts "Exception when calling RepositoriesFileApi->unset_label: #{e}" end ``` ### Parameters @@ -798,13 +798,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## repositories_file_file_update +## update -> AsyncOperationResponse repositories_file_file_update(file_file_repository_href, file_file_repository) +> AsyncOperationResponse update(file_file_repository_href, file_file_repository) Update a file repository Trigger an asynchronous update task @@ -824,13 +824,13 @@ file_file_repository_href = 'file_file_repository_href_example' # String | file_file_repository = PulpFileClient::FileFileRepository.new # FileFileRepository | begin #Update a file repository - result = api_instance.repositories_file_file_update(file_file_repository_href, file_file_repository) + result = api_instance.update(file_file_repository_href, file_file_repository) p result rescue PulpFileClient::ApiError => e - puts "Exception when calling RepositoriesFileApi->repositories_file_file_update: #{e}" + puts "Exception when calling RepositoriesFileApi->update: #{e}" end ``` ### Parameters