pulp_file_client 3.49.14 → 3.50.0

data/docs/GroupsRolesApi.md

@@ -1,263 +0,0 @@
-# PulpFileClient::GroupsRolesApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**groups_roles_create**](GroupsRolesApi.md#groups_roles_create) | **POST** {group_href}roles/ | Create a group role
-[**groups_roles_delete**](GroupsRolesApi.md#groups_roles_delete) | **DELETE** {groups_group_role_href} | Delete a group role
-[**groups_roles_list**](GroupsRolesApi.md#groups_roles_list) | **GET** {group_href}roles/ | List group roles
-[**groups_roles_read**](GroupsRolesApi.md#groups_roles_read) | **GET** {groups_group_role_href} | Inspect a group role
-
-
-
-## groups_roles_create
-
-> GroupRoleResponse groups_roles_create(group_href, group_role)
-
-Create a group role
-
-ViewSet for GroupRole.
-
-### 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::GroupsRolesApi.new
-group_href = 'group_href_example' # String | 
-group_role = PulpFileClient::GroupRole.new # GroupRole | 
-
-begin
-  #Create a group role
-  result = api_instance.groups_roles_create(group_href, group_role)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsRolesApi->groups_roles_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **group_role** | [**GroupRole**](GroupRole.md)|  | 
-
-### Return type
-
-[**GroupRoleResponse**](GroupRoleResponse.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_roles_delete
-
-> groups_roles_delete(groups_group_role_href)
-
-Delete a group role
-
-ViewSet for GroupRole.
-
-### 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::GroupsRolesApi.new
-groups_group_role_href = 'groups_group_role_href_example' # String | 
-
-begin
-  #Delete a group role
-  api_instance.groups_roles_delete(groups_group_role_href)
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsRolesApi->groups_roles_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **groups_group_role_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## groups_roles_list
-
-> PaginatedGroupRoleResponseList groups_roles_list(group_href, opts)
-
-List group roles
-
-ViewSet for GroupRole.
-
-### 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::GroupsRolesApi.new
-group_href = 'group_href_example' # String | 
-opts = {
-  content_object: 'content_object_example', # String | content_object
-  domain: 'domain_example', # String | Foreign Key referenced by HREF
-  limit: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | The initial index from which to return the results.
-  ordering: ['ordering_example'], # Array<String> | Ordering  * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (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 | 
-  role: 'role_example', # String | 
-  role__contains: 'role__contains_example', # String | 
-  role__icontains: 'role__icontains_example', # String | 
-  role__in: ['role__in_example'], # Array<String> | Multiple values may be separated by commas.
-  role__startswith: 'role__startswith_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 group roles
-  result = api_instance.groups_roles_list(group_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsRolesApi->groups_roles_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **content_object** | **String**| content_object | [optional] 
- **domain** | [**String**](.md)| Foreign Key referenced by HREF | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **ordering** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;role&#x60; - Role * &#x60;-role&#x60; - Role (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (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] 
- **role** | **String**|  | [optional] 
- **role__contains** | **String**|  | [optional] 
- **role__icontains** | **String**|  | [optional] 
- **role__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [optional] 
- **role__startswith** | **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
-
-[**PaginatedGroupRoleResponseList**](PaginatedGroupRoleResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
-## groups_roles_read
-
-> GroupRoleResponse groups_roles_read(groups_group_role_href, opts)
-
-Inspect a group role
-
-ViewSet for GroupRole.
-
-### 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::GroupsRolesApi.new
-groups_group_role_href = 'groups_group_role_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 role
-  result = api_instance.groups_roles_read(groups_group_role_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsRolesApi->groups_roles_read: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **groups_group_role_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
-
-[**GroupRoleResponse**](GroupRoleResponse.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/GroupsUsersApi.md

@@ -1,181 +0,0 @@
-# PulpFileClient::GroupsUsersApi
-
-All URIs are relative to *http://localhost:24817*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**groups_users_create**](GroupsUsersApi.md#groups_users_create) | **POST** {group_href}users/ | Create an user
-[**groups_users_delete**](GroupsUsersApi.md#groups_users_delete) | **DELETE** {groups_user_href} | Delete an user
-[**groups_users_list**](GroupsUsersApi.md#groups_users_list) | **GET** {group_href}users/ | List users
-
-
-
-## groups_users_create
-
-> GroupUserResponse groups_users_create(group_href, group_user)
-
-Create an user
-
-Add a user to a 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::GroupsUsersApi.new
-group_href = 'group_href_example' # String | 
-group_user = PulpFileClient::GroupUser.new # GroupUser | 
-
-begin
-  #Create an user
-  result = api_instance.groups_users_create(group_href, group_user)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsUsersApi->groups_users_create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **group_user** | [**GroupUser**](GroupUser.md)|  | 
-
-### Return type
-
-[**GroupUserResponse**](GroupUserResponse.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_users_delete
-
-> groups_users_delete(groups_user_href)
-
-Delete an user
-
-Remove a user from a 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::GroupsUsersApi.new
-groups_user_href = 'groups_user_href_example' # String | 
-
-begin
-  #Delete an user
-  api_instance.groups_users_delete(groups_user_href)
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsUsersApi->groups_users_delete: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **groups_user_href** | **String**|  | 
-
-### Return type
-
-nil (empty response body)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-## groups_users_list
-
-> PaginatedGroupUserResponseList groups_users_list(group_href, opts)
-
-List users
-
-List group users.
-
-### 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::GroupsUsersApi.new
-group_href = 'group_href_example' # String | 
-opts = {
-  limit: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | The initial index from which to return the results.
-  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 users
-  result = api_instance.groups_users_list(group_href, opts)
-  p result
-rescue PulpFileClient::ApiError => e
-  puts "Exception when calling GroupsUsersApi->groups_users_list: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **group_href** | **String**|  | 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [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
-
-[**PaginatedGroupUserResponseList**](PaginatedGroupUserResponseList.md)
-
-### Authorization
-
-[basicAuth](../README.md#basicAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/HeaderContentGuard.md

@@ -1,25 +0,0 @@
-# PulpFileClient::HeaderContentGuard
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-**header_name** | **String** | The header name the guard will check on. | 
-**header_value** | **String** | The value that will authorize the request. | 
-**jq_filter** | **String** | A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::HeaderContentGuard.new(name: null,
-                                 description: null,
-                                 header_name: null,
-                                 header_value: null,
-                                 jq_filter: null)
-```
-
-

data/docs/HeaderContentGuardResponse.md

@@ -1,31 +0,0 @@
-# PulpFileClient::HeaderContentGuardResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**name** | **String** | The unique name. | 
-**description** | **String** | An optional description. | [optional] 
-**header_name** | **String** | The header name the guard will check on. | 
-**header_value** | **String** | The value that will authorize the request. | 
-**jq_filter** | **String** | A JQ syntax compatible filter. If jq_filter is not set, then the value willonly be Base64 decoded and checked as an explicit string match. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::HeaderContentGuardResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 description: null,
-                                 header_name: null,
-                                 header_value: null,
-                                 jq_filter: null)
-```
-
-

data/docs/ImportResponse.md

@@ -1,25 +0,0 @@
-# PulpFileClient::ImportResponse
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
-**pulp_last_updated** | **DateTime** | Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same. | [optional] [readonly] 
-**task** | **String** | A URI of the Task that ran the Import. | 
-**params** | [**Object**](.md) | Any parameters that were used to create the import. | 
-
-## Code Sample
-
-```ruby
-require 'PulpFileClient'
-
-instance = PulpFileClient::ImportResponse.new(pulp_href: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 task: null,
-                                 params: null)
-```
-
-