pulp_container_client 2.14.12 → 2.14.14

data/docs/GroupsRolesApi.md

@@ -0,0 +1,261 @@
+# PulpContainerClient::GroupsRolesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsRolesApi.md#create) | **POST** {group_href}roles/ | Create a group role
+[**delete**](GroupsRolesApi.md#delete) | **DELETE** {groups_group_role_href} | Delete a group role
+[**list**](GroupsRolesApi.md#list) | **GET** {group_href}roles/ | List group roles
+[**read**](GroupsRolesApi.md#read) | **GET** {groups_group_role_href} | Inspect a group role
+
+
+
+## create
+
+> GroupRoleResponse create(group_href, group_role)
+
+Create a group role
+
+ViewSet for GroupRole.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::GroupsRolesApi.new
+group_href = 'group_href_example' # String | 
+group_role = PulpContainerClient::GroupRole.new # GroupRole | 
+
+begin
+  #Create a group role
+  result = api_instance.create(group_href, group_role)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->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
+
+
+## delete
+
+> delete(groups_group_role_href)
+
+Delete a group role
+
+ViewSet for GroupRole.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::GroupsRolesApi.new
+groups_group_role_href = 'groups_group_role_href_example' # String | 
+
+begin
+  #Delete a group role
+  api_instance.delete(groups_group_role_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->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
+
+
+## list
+
+> PaginatedGroupRoleResponseList list(group_href, opts)
+
+List group roles
+
+ViewSet for GroupRole.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::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.
+  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.list(group_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_href** | **String**|  | 
+ **content_object** | **String**| content_object | [optional] 
+ **domain** | **String**| 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] 
+ **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
+
+
+## read
+
+> GroupRoleResponse read(groups_group_role_href, opts)
+
+Inspect a group role
+
+ViewSet for GroupRole.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::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.read(groups_group_role_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsRolesApi->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

@@ -0,0 +1,181 @@
+# PulpContainerClient::GroupsUsersApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](GroupsUsersApi.md#create) | **POST** {group_href}users/ | Create an user
+[**delete**](GroupsUsersApi.md#delete) | **DELETE** {groups_user_href} | Delete an user
+[**list**](GroupsUsersApi.md#list) | **GET** {group_href}users/ | List users
+
+
+
+## create
+
+> GroupUserResponse create(group_href, group_user)
+
+Create an user
+
+Add a user to a group.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::GroupsUsersApi.new
+group_href = 'group_href_example' # String | 
+group_user = PulpContainerClient::GroupUser.new # GroupUser | 
+
+begin
+  #Create an user
+  result = api_instance.create(group_href, group_user)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->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
+
+
+## delete
+
+> delete(groups_user_href)
+
+Delete an user
+
+Remove a user from a group.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::GroupsUsersApi.new
+groups_user_href = 'groups_user_href_example' # String | 
+
+begin
+  #Delete an user
+  api_instance.delete(groups_user_href)
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->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
+
+
+## list
+
+> PaginatedGroupUserResponseList list(group_href, opts)
+
+List users
+
+List group users.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_container_client'
+# setup authorization
+PulpContainerClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpContainerClient::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.list(group_href, opts)
+  p result
+rescue PulpContainerClient::ApiError => e
+  puts "Exception when calling GroupsUsersApi->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/ImportResponse.md

@@ -0,0 +1,23 @@
+# PulpContainerClient::ImportResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [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 'PulpContainerClient'
+
+instance = PulpContainerClient::ImportResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 task: null,
+                                 params: null)
+```
+
+