pulpcore_client 3.69.2 → 3.70.0

data/docs/UsersRolesApi.md

@@ -2,27 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](UsersRolesApi.md#create) | **POST** {auth_user_href}roles/ | Create an user role
-[**delete**](UsersRolesApi.md#delete) | **DELETE** {auth_users_user_role_href} | Delete an user role
-[**list**](UsersRolesApi.md#list) | **GET** {auth_user_href}roles/ | List user roles
-[**read**](UsersRolesApi.md#read) | **GET** {auth_users_user_role_href} | Inspect an user role
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](UsersRolesApi.md#create) | **POST** {auth_user_href}roles/ | Create an user role |
+| [**delete**](UsersRolesApi.md#delete) | **DELETE** {auth_users_user_role_href} | Delete an user role |
+| [**list**](UsersRolesApi.md#list) | **GET** {auth_user_href}roles/ | List user roles |
+| [**read**](UsersRolesApi.md#read) | **GET** {auth_users_user_role_href} | Inspect an user role |
 
 
 ## create
 
-> UserRoleResponse create(auth_user_href, user_role)
+> <UserRoleResponse> create(auth_user_href, user_role)
 
 Create an user role
 
 ViewSet for UserRole.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -33,24 +32,41 @@ end
 
 api_instance = PulpcoreClient::UsersRolesApi.new
 auth_user_href = 'auth_user_href_example' # String | 
-user_role = PulpcoreClient::UserRole.new # UserRole | 
+user_role = PulpcoreClient::UserRole.new({role: 'role_example', content_object: 'content_object_example'}) # UserRole | 
 
 begin
-  #Create an user role
+  # Create an user role
   result = api_instance.create(auth_user_href, user_role)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->create: #{e}"
+  puts "Error when calling UsersRolesApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
 
+> <Array(<UserRoleResponse>, Integer, Hash)> create_with_http_info(auth_user_href, user_role)
+
+```ruby
+begin
+  # Create an user role
+  data, status_code, headers = api_instance.create_with_http_info(auth_user_href, user_role)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserRoleResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersRolesApi->create_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_href** | **String**|  | 
- **user_role** | [**UserRole**](UserRole.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_href** | **String** |  |  |
+| **user_role** | [**UserRole**](UserRole.md) |  |  |
 
 ### Return type
 
@@ -74,10 +90,10 @@ Delete an user role
 
 ViewSet for UserRole.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -90,19 +106,36 @@ api_instance = PulpcoreClient::UsersRolesApi.new
 auth_users_user_role_href = 'auth_users_user_role_href_example' # String | 
 
 begin
-  #Delete an user role
+  # Delete an user role
   api_instance.delete(auth_users_user_role_href)
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->delete: #{e}"
+  puts "Error when calling UsersRolesApi->delete: #{e}"
 end
 ```
 
-### Parameters
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_with_http_info(auth_users_user_role_href)
+
+```ruby
+begin
+  # Delete an user role
+  data, status_code, headers = api_instance.delete_with_http_info(auth_users_user_role_href)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersRolesApi->delete_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_users_user_role_href** | **String**|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_users_user_role_href** | **String** |  |  |
 
 ### Return type
 
@@ -120,16 +153,16 @@ nil (empty response body)
 
 ## list
 
-> PaginatedUserRoleResponseList list(auth_user_href, opts)
+> <PaginatedUserRoleResponseList> list(auth_user_href, opts)
 
 List user roles
 
 ViewSet for UserRole.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -142,54 +175,71 @@ api_instance = PulpcoreClient::UsersRolesApi.new
 auth_user_href = 'auth_user_href_example' # String | 
 opts = {
   content_object: 'content_object_example', # String | content_object
-  domain: 'domain_example', # String | Foreign Key referenced by HREF
+  domain: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # 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)
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  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.
+  ordering: ['-description'], # 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)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
   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__in: ['inner_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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #List user roles
+  # List user roles
   result = api_instance.list(auth_user_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->list: #{e}"
+  puts "Error when calling UsersRolesApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedUserRoleResponseList>, Integer, Hash)> list_with_http_info(auth_user_href, opts)
+
+```ruby
+begin
+  # List user roles
+  data, status_code, headers = api_instance.list_with_http_info(auth_user_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedUserRoleResponseList>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersRolesApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_user_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] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [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**| Filter results by using NOT, AND and OR operations on other filters | [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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_user_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] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [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** | Filter results by using NOT, AND and OR operations on other filters | [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
 
@@ -207,16 +257,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> UserRoleResponse read(auth_users_user_role_href, opts)
+> <UserRoleResponse> read(auth_users_user_role_href, opts)
 
 Inspect an user role
 
 ViewSet for UserRole.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
@@ -228,27 +278,44 @@ end
 api_instance = PulpcoreClient::UsersRolesApi.new
 auth_users_user_role_href = 'auth_users_user_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.
+  fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
+  exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
 }
 
 begin
-  #Inspect an user role
+  # Inspect an user role
   result = api_instance.read(auth_users_user_role_href, opts)
   p result
 rescue PulpcoreClient::ApiError => e
-  puts "Exception when calling UsersRolesApi->read: #{e}"
+  puts "Error when calling UsersRolesApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserRoleResponse>, Integer, Hash)> read_with_http_info(auth_users_user_role_href, opts)
+
+```ruby
+begin
+  # Inspect an user role
+  data, status_code, headers = api_instance.read_with_http_info(auth_users_user_role_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserRoleResponse>
+rescue PulpcoreClient::ApiError => e
+  puts "Error when calling UsersRolesApi->read_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **auth_users_user_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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **auth_users_user_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
 

data/docs/VersionResponse.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**component** | **String** | Name of a versioned component of Pulp | 
-**version** | **String** | Version of the component (e.g. 3.0.0) | 
-**package** | **String** | Python package name providing the component | 
-**_module** | **String** | Python module name of the component | 
-**domain_compatible** | **Boolean** | Domain feature compatibility of component | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component** | **String** | Name of a versioned component of Pulp |  |
+| **version** | **String** | Version of the component (e.g. 3.0.0) |  |
+| **package** | **String** | Python package name providing the component |  |
+| **_module** | **String** | Python module name of the component |  |
+| **domain_compatible** | **Boolean** | Domain feature compatibility of component |  |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::VersionResponse.new(component: null,
-                                 version: null,
-                                 package: null,
-                                 _module: null,
-                                 domain_compatible: null)
+instance = PulpcoreClient::VersionResponse.new(
+  component: null,
+  version: null,
+  package: null,
+  _module: null,
+  domain_compatible: null
+)
 ```
 
-

data/docs/WorkerResponse.md

@@ -2,30 +2,31 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**pulp_href** | **String** |  | [optional] [readonly] 
-**prn** | **String** | The Pulp Resource Name (PRN). | [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 name of the worker. | [optional] [readonly] 
-**last_heartbeat** | **DateTime** | Timestamp of the last time the worker talked to the service. | [optional] [readonly] 
-**versions** | **Hash<String, String>** | Versions of the components installed. | [optional] [readonly] 
-**current_task** | **String** | The task this worker is currently executing, or empty if the worker is not currently assigned to a task. | [optional] [readonly] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_href** | **String** |  | [optional][readonly] |
+| **prn** | **String** | The Pulp Resource Name (PRN). | [optional][readonly] |
+| **pulp_created** | **Time** | Timestamp of creation. | [optional][readonly] |
+| **pulp_last_updated** | **Time** | 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 name of the worker. | [optional][readonly] |
+| **last_heartbeat** | **Time** | Timestamp of the last time the worker talked to the service. | [optional][readonly] |
+| **versions** | **Hash<String, String>** | Versions of the components installed. | [optional][readonly] |
+| **current_task** | **String** | The task this worker is currently executing, or empty if the worker is not currently assigned to a task. | [optional][readonly] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'PulpcoreClient'
+require 'pulpcore_client'
 
-instance = PulpcoreClient::WorkerResponse.new(pulp_href: null,
-                                 prn: null,
-                                 pulp_created: null,
-                                 pulp_last_updated: null,
-                                 name: null,
-                                 last_heartbeat: null,
-                                 versions: null,
-                                 current_task: null)
+instance = PulpcoreClient::WorkerResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  name: null,
+  last_heartbeat: null,
+  versions: null,
+  current_task: null
+)
 ```
 
-