pulp_file_client 3.55.2 → 3.56.0

data/docs/GroupsApi.md

@@ -1,603 +0,0 @@
-# PulpFileClient::GroupsApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**groups_add_role**](GroupsApi.md#groups_add_role) | **POST** {group_href}add_role/ | Add a role
-[**groups_create**](GroupsApi.md#groups_create) | **POST** /pulp/api/v3/groups/ | Create a group
-[**groups_delete**](GroupsApi.md#groups_delete) | **DELETE** {group_href} | Delete a group
-[**groups_list**](GroupsApi.md#groups_list) | **GET** /pulp/api/v3/groups/ | List groups
-[**groups_list_roles**](GroupsApi.md#groups_list_roles) | **GET** {group_href}list_roles/ | List roles
-[**groups_my_permissions**](GroupsApi.md#groups_my_permissions) | **GET** {group_href}my_permissions/ | List user permissions
-[**groups_partial_update**](GroupsApi.md#groups_partial_update) | **PATCH** {group_href} | Update a group
-[**groups_read**](GroupsApi.md#groups_read) | **GET** {group_href} | Inspect a group
-[**groups_remove_role**](GroupsApi.md#groups_remove_role) | **POST** {group_href}remove_role/ | Remove a role
-[**groups_update**](GroupsApi.md#groups_update) | **PUT** {group_href} | Update a group
-
-
-
-## groups_add_role
-
-> NestedRoleResponse groups_add_role(group_href, nested_role)
-
-Add a 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-nested_role = PulpFileClient::NestedRole.new # NestedRole | 
-
-begin
-  #Add a role
-  result = api_instance.groups_add_role(group_href, nested_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_add_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_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
-
-
-## groups_create
-
-> GroupResponse groups_create(group)
-
-Create a group
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-group = PulpFileClient::Group.new # Group | 
-
-begin
-  #Create a group
-  result = api_instance.groups_create(group)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group** | [**Group**](Group.md)|  | 
-
-### Return type
-
-[**GroupResponse**](GroupResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## groups_delete
-
-> groups_delete(group_href)
-
-Delete a group
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-
-begin
-  #Delete a group
-  api_instance.groups_delete(group_href)
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## groups_list
-
-> PaginatedGroupResponseList groups_list(opts)
-
-List groups
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-opts = {
-  id: 56, # Integer | Filter results where id matches value
-  id__in: [56], # Array<Integer> | Filter results where id is in a comma-separated list of values
-  limit: 56, # Integer | Number of results to return per page.
-  name: 'name_example', # String | Filter results where name matches value
-  name__contains: 'name__contains_example', # String | Filter results where name contains value
-  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
-  name__iexact: 'name__iexact_example', # String | Filter results where name matches value
-  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
-  offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering  * `id` - Id * `-id` - Id (descending) * `name` - Name * `-name` - Name (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
-  q: 'q_example', # String | 
-  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
-  #List groups
-  result = api_instance.groups_list(opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **Integer**| Filter results where id matches value | [optional] 
- **id__in** | [**Array&lt;Integer&gt;**](Integer.md)| Filter results where id is in a comma-separated list of values | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**| Filter results where name matches value | [optional] 
- **name__contains** | **String**| Filter results where name contains value | [optional] 
- **name__icontains** | **String**| Filter results where name contains value | [optional] 
- **name__iexact** | **String**| Filter results where name matches value | [optional] 
- **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;id&#x60; - Id * &#x60;-id&#x60; - Id (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **pulp_href__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **pulp_id__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **q** | **String**|  | [optional] 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**PaginatedGroupResponseList**](PaginatedGroupResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## groups_list_roles
-
-> ObjectRolesResponse groups_list_roles(group_href, opts)
-
-List roles
-
-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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-opts = {
-  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
-  #List roles
-  result = api_instance.groups_list_roles(group_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_list_roles: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| 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
-
-
-## groups_my_permissions
-
-> MyPermissionsResponse groups_my_permissions(group_href, opts)
-
-List user permissions
-
-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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-opts = {
-  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
-  #List user permissions
-  result = api_instance.groups_my_permissions(group_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_my_permissions: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| 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
-
-
-## groups_partial_update
-
-> GroupResponse groups_partial_update(group_href, patched_group)
-
-Update a group
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-patched_group = PulpFileClient::PatchedGroup.new # PatchedGroup | 
-
-begin
-  #Update a group
-  result = api_instance.groups_partial_update(group_href, patched_group)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_partial_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **patched_group** | [**PatchedGroup**](PatchedGroup.md)|  | 
-
-### Return type
-
-[**GroupResponse**](GroupResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-
-
-## groups_read
-
-> GroupResponse groups_read(group_href, opts)
-
-Inspect a group
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-opts = {
-  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
-  #Inspect a group
-  result = api_instance.groups_read(group_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to include in the response. | [optional] 
- **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
-
-### Return type
-
-[**GroupResponse**](GroupResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## groups_remove_role
-
-> NestedRoleResponse groups_remove_role(group_href, nested_role)
-
-Remove a 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-nested_role = PulpFileClient::NestedRole.new # NestedRole | 
-
-begin
-  #Remove a role
-  result = api_instance.groups_remove_role(group_href, nested_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_remove_role: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_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
-
-
-## groups_update
-
-> GroupResponse groups_update(group_href, group)
-
-Update a group
-
-ViewSet for Group.
-
-### 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::GroupsApi.new
-group_href = 'group_href_example' # String | 
-group = PulpFileClient::Group.new # Group | 
-
-begin
-  #Update a group
-  result = api_instance.groups_update(group_href, group)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsApi->groups_update: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **group** | [**Group**](Group.md)|  | 
-
-### Return type
-
-[**GroupResponse**](GroupResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
-- **Accept**: application/json
-