docs/DistributionsContainerApi.md in pulp_container_client-2.14.15 vs docs/DistributionsContainerApi.md in pulp_container_client-2.14.16

- old
+ new

@@ -1,27 +1,27 @@ # PulpContainerClient::DistributionsContainerApi -All URIs are relative to *https://pulp* +All URIs are relative to *http://localhost:24817* Method | HTTP request | Description ------------- | ------------- | ------------- -[**add_role**](DistributionsContainerApi.md#add_role) | **POST** {container_container_distribution_href}add_role/ | -[**create**](DistributionsContainerApi.md#create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution -[**delete**](DistributionsContainerApi.md#delete) | **DELETE** {container_container_distribution_href} | Delete a container distribution -[**list**](DistributionsContainerApi.md#list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions -[**list_roles**](DistributionsContainerApi.md#list_roles) | **GET** {container_container_distribution_href}list_roles/ | -[**my_permissions**](DistributionsContainerApi.md#my_permissions) | **GET** {container_container_distribution_href}my_permissions/ | -[**partial_update**](DistributionsContainerApi.md#partial_update) | **PATCH** {container_container_distribution_href} | Update a container distribution -[**read**](DistributionsContainerApi.md#read) | **GET** {container_container_distribution_href} | Inspect a container distribution -[**remove_role**](DistributionsContainerApi.md#remove_role) | **POST** {container_container_distribution_href}remove_role/ | -[**update**](DistributionsContainerApi.md#update) | **PUT** {container_container_distribution_href} | Update a container distribution +[**distributions_container_container_add_role**](DistributionsContainerApi.md#distributions_container_container_add_role) | **POST** {container_container_distribution_href}add_role/ | +[**distributions_container_container_create**](DistributionsContainerApi.md#distributions_container_container_create) | **POST** /pulp/api/v3/distributions/container/container/ | Create a container distribution +[**distributions_container_container_delete**](DistributionsContainerApi.md#distributions_container_container_delete) | **DELETE** {container_container_distribution_href} | Delete a container distribution +[**distributions_container_container_list**](DistributionsContainerApi.md#distributions_container_container_list) | **GET** /pulp/api/v3/distributions/container/container/ | List container distributions +[**distributions_container_container_list_roles**](DistributionsContainerApi.md#distributions_container_container_list_roles) | **GET** {container_container_distribution_href}list_roles/ | +[**distributions_container_container_my_permissions**](DistributionsContainerApi.md#distributions_container_container_my_permissions) | **GET** {container_container_distribution_href}my_permissions/ | +[**distributions_container_container_partial_update**](DistributionsContainerApi.md#distributions_container_container_partial_update) | **PATCH** {container_container_distribution_href} | Update a container distribution +[**distributions_container_container_read**](DistributionsContainerApi.md#distributions_container_container_read) | **GET** {container_container_distribution_href} | Inspect a container distribution +[**distributions_container_container_remove_role**](DistributionsContainerApi.md#distributions_container_container_remove_role) | **POST** {container_container_distribution_href}remove_role/ | +[**distributions_container_container_update**](DistributionsContainerApi.md#distributions_container_container_update) | **PUT** {container_container_distribution_href} | Update a container distribution -## add_role +## distributions_container_container_add_role -> NestedRoleResponse add_role(container_container_distribution_href, nested_role) +> NestedRoleResponse distributions_container_container_add_role(container_container_distribution_href, nested_role) Add a role for this object to users/groups. @@ -40,14 +40,14 @@ api_instance = PulpContainerClient::DistributionsContainerApi.new container_container_distribution_href = 'container_container_distribution_href_example' # String | nested_role = PulpContainerClient::NestedRole.new # NestedRole | begin - result = api_instance.add_role(container_container_distribution_href, nested_role) + result = api_instance.distributions_container_container_add_role(container_container_distribution_href, nested_role) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->add_role: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_add_role: #{e}" end ``` ### Parameters @@ -69,13 +69,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## create +## distributions_container_container_create -> AsyncOperationResponse create(container_container_distribution) +> AsyncOperationResponse distributions_container_container_create(container_container_distribution) Create a container distribution Trigger an asynchronous create task @@ -94,14 +94,14 @@ api_instance = PulpContainerClient::DistributionsContainerApi.new container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution | begin #Create a container distribution - result = api_instance.create(container_container_distribution) + result = api_instance.distributions_container_container_create(container_container_distribution) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->create: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_create: #{e}" end ``` ### Parameters @@ -122,13 +122,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## delete +## distributions_container_container_delete -> AsyncOperationResponse delete(container_container_distribution_href) +> AsyncOperationResponse distributions_container_container_delete(container_container_distribution_href) Delete a container distribution Trigger an asynchronous delete task @@ -147,14 +147,14 @@ api_instance = PulpContainerClient::DistributionsContainerApi.new container_container_distribution_href = 'container_container_distribution_href_example' # String | begin #Delete a container distribution - result = api_instance.delete(container_container_distribution_href) + result = api_instance.distributions_container_container_delete(container_container_distribution_href) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->delete: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_delete: #{e}" end ``` ### Parameters @@ -175,13 +175,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## list +## distributions_container_container_list -> PaginatedcontainerContainerDistributionResponseList list(opts) +> PaginatedcontainerContainerDistributionResponseList distributions_container_container_list(opts) List container distributions The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both. @@ -218,14 +218,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #List container distributions - result = api_instance.list(opts) + result = api_instance.distributions_container_container_list(opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->list: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_list: #{e}" end ``` ### Parameters @@ -262,13 +262,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## list_roles +## distributions_container_container_list_roles -> ObjectRolesResponse list_roles(container_container_distribution_href, opts) +> ObjectRolesResponse distributions_container_container_list_roles(container_container_distribution_href, opts) List roles assigned to this object. @@ -290,14 +290,14 @@ 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 - result = api_instance.list_roles(container_container_distribution_href, opts) + result = api_instance.distributions_container_container_list_roles(container_container_distribution_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->list_roles: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_list_roles: #{e}" end ``` ### Parameters @@ -320,13 +320,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## my_permissions +## distributions_container_container_my_permissions -> MyPermissionsResponse my_permissions(container_container_distribution_href, opts) +> MyPermissionsResponse distributions_container_container_my_permissions(container_container_distribution_href, opts) List permissions available to the current user on this object. @@ -348,14 +348,14 @@ 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 - result = api_instance.my_permissions(container_container_distribution_href, opts) + result = api_instance.distributions_container_container_my_permissions(container_container_distribution_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->my_permissions: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_my_permissions: #{e}" end ``` ### Parameters @@ -378,13 +378,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## partial_update +## distributions_container_container_partial_update -> AsyncOperationResponse partial_update(container_container_distribution_href, patchedcontainer_container_distribution) +> AsyncOperationResponse distributions_container_container_partial_update(container_container_distribution_href, patchedcontainer_container_distribution) Update a container distribution Trigger an asynchronous partial update task @@ -404,14 +404,14 @@ container_container_distribution_href = 'container_container_distribution_href_example' # String | patchedcontainer_container_distribution = PulpContainerClient::PatchedcontainerContainerDistribution.new # PatchedcontainerContainerDistribution | begin #Update a container distribution - result = api_instance.partial_update(container_container_distribution_href, patchedcontainer_container_distribution) + result = api_instance.distributions_container_container_partial_update(container_container_distribution_href, patchedcontainer_container_distribution) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->partial_update: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_partial_update: #{e}" end ``` ### Parameters @@ -433,13 +433,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## read +## distributions_container_container_read -> ContainerContainerDistributionResponse read(container_container_distribution_href, opts) +> ContainerContainerDistributionResponse distributions_container_container_read(container_container_distribution_href, opts) Inspect a container distribution The Container Distribution will serve the latest version of a Repository if ``repository`` is specified. The Container Distribution will serve a specific repository version if ``repository_version``. Note that **either** ``repository`` or ``repository_version`` can be set on a Container Distribution, but not both. @@ -462,14 +462,14 @@ exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response. } begin #Inspect a container distribution - result = api_instance.read(container_container_distribution_href, opts) + result = api_instance.distributions_container_container_read(container_container_distribution_href, opts) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->read: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_read: #{e}" end ``` ### Parameters @@ -492,13 +492,13 @@ - **Content-Type**: Not defined - **Accept**: application/json -## remove_role +## distributions_container_container_remove_role -> NestedRoleResponse remove_role(container_container_distribution_href, nested_role) +> NestedRoleResponse distributions_container_container_remove_role(container_container_distribution_href, nested_role) Remove a role for this object from users/groups. @@ -517,14 +517,14 @@ api_instance = PulpContainerClient::DistributionsContainerApi.new container_container_distribution_href = 'container_container_distribution_href_example' # String | nested_role = PulpContainerClient::NestedRole.new # NestedRole | begin - result = api_instance.remove_role(container_container_distribution_href, nested_role) + result = api_instance.distributions_container_container_remove_role(container_container_distribution_href, nested_role) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->remove_role: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_remove_role: #{e}" end ``` ### Parameters @@ -546,13 +546,13 @@ - **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data - **Accept**: application/json -## update +## distributions_container_container_update -> AsyncOperationResponse update(container_container_distribution_href, container_container_distribution) +> AsyncOperationResponse distributions_container_container_update(container_container_distribution_href, container_container_distribution) Update a container distribution Trigger an asynchronous update task @@ -572,13 +572,13 @@ container_container_distribution_href = 'container_container_distribution_href_example' # String | container_container_distribution = PulpContainerClient::ContainerContainerDistribution.new # ContainerContainerDistribution | begin #Update a container distribution - result = api_instance.update(container_container_distribution_href, container_container_distribution) + result = api_instance.distributions_container_container_update(container_container_distribution_href, container_container_distribution) p result rescue PulpContainerClient::ApiError => e - puts "Exception when calling DistributionsContainerApi->update: #{e}" + puts "Exception when calling DistributionsContainerApi->distributions_container_container_update: #{e}" end ``` ### Parameters