pulpcore_client 3.5.0 → 3.6.0

data/docs/UploadsApi.md

@@ -15,7 +15,7 @@ Method | HTTP request | Description
 
 ## commit
 
-> AsyncOperationResponse commit(upload_href, data)
+> AsyncOperationResponse commit(upload_href, upload_commit)
 
 Finish an Upload
 
@@ -28,18 +28,18 @@ Queues a Task that creates an Artifact, and the Upload gets deleted and cannot b
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
-upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
-data = PulpcoreClient::UploadCommit.new # UploadCommit | 
+upload_href = 'upload_href_example' # String | 
+upload_commit = PulpcoreClient::UploadCommit.new # UploadCommit | 
 
 begin
   #Finish an Upload
-  result = api_instance.commit(upload_href, data)
+  result = api_instance.commit(upload_href, upload_commit)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling UploadsApi->commit: #{e}"
@@ -51,8 +51,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ | 
- **data** | [**UploadCommit**](UploadCommit.md)|  | 
+ **upload_href** | **String**|  | 
+ **upload_commit** | [**UploadCommit**](UploadCommit.md)|  | 
 
 ### Return type
 
@@ -60,17 +60,17 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
 ## create
 
-> Upload create(data)
+> UploadResponse create(upload)
 
 Create an upload
 
@@ -83,17 +83,17 @@ View for chunked uploads.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
-data = PulpcoreClient::Upload.new # Upload | 
+upload = PulpcoreClient::Upload.new # Upload | 
 
 begin
   #Create an upload
-  result = api_instance.create(data)
+  result = api_instance.create(upload)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling UploadsApi->create: #{e}"
@@ -105,19 +105,19 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **data** | [**Upload**](Upload.md)|  | 
+ **upload** | [**Upload**](Upload.md)|  | 
 
 ### Return type
 
-[**Upload**](Upload.md)
+[**UploadResponse**](UploadResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
 - **Accept**: application/json
 
 
@@ -136,13 +136,13 @@ View for chunked uploads.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
-upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+upload_href = 'upload_href_example' # String | 
 
 begin
   #Delete an upload
@@ -157,7 +157,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ | 
+ **upload_href** | **String**|  | 
 
 ### Return type
 
@@ -165,7 +165,7 @@ nil (empty response body)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -175,7 +175,7 @@ nil (empty response body)
 
 ## list
 
-> InlineResponse2008 list(opts)
+> InlineResponse20012 list(opts)
 
 List uploads
 
@@ -188,16 +188,16 @@ View for chunked uploads.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
   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', # String | Which field to use when ordering the results.
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
 }
@@ -216,19 +216,19 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
 ### Return type
 
-[**InlineResponse2008**](InlineResponse2008.md)
+[**InlineResponse20012**](InlineResponse20012.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -238,7 +238,7 @@ Name | Type | Description  | Notes
 
 ## read
 
-> UploadDetail read(upload_href, opts)
+> UploadDetailResponse read(upload_href, opts)
 
 Inspect an upload
 
@@ -251,13 +251,13 @@ View for chunked uploads.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
-upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
+upload_href = 'upload_href_example' # String | 
 opts = {
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -277,17 +277,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ | 
+ **upload_href** | **String**|  | 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
 ### Return type
 
-[**UploadDetail**](UploadDetail.md)
+[**UploadDetailResponse**](UploadDetailResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -297,7 +297,7 @@ Name | Type | Description  | Notes
 
 ## update
 
-> Upload update(upload_href, content_range, file, opts)
+> UploadResponse update(content_range, upload_href, file, opts)
 
 Upload a file chunk
 
@@ -310,22 +310,23 @@ Upload a chunk for an upload.
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::UploadsApi.new
-upload_href = 'upload_href_example' # String | URI of Upload. e.g.: /pulp/api/v3/uploads/1/
 content_range = 'content_range_example' # String | The Content-Range header specifies the location of the file chunk within the file.
+upload_href = 'upload_href_example' # String | 
 file = File.new('/path/to/file') # File | A chunk of the uploaded file.
 opts = {
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
   sha256: 'sha256_example' # String | The SHA-256 checksum of the chunk if available.
 }
 
 begin
   #Upload a file chunk
-  result = api_instance.update(upload_href, content_range, file, opts)
+  result = api_instance.update(content_range, upload_href, file, opts)
   p result
 rescue PulpcoreClient::ApiError => e
   puts "Exception when calling UploadsApi->update: #{e}"
@@ -337,18 +338,19 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **upload_href** | **String**| URI of Upload. e.g.: /pulp/api/v3/uploads/1/ | 
  **content_range** | **String**| The Content-Range header specifies the location of the file chunk within the file. | 
+ **upload_href** | **String**|  | 
  **file** | **File**| A chunk of the uploaded file. | 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
  **sha256** | **String**| The SHA-256 checksum of the chunk if available. | [optional] 
 
 ### Return type
 
-[**Upload**](Upload.md)
+[**UploadResponse**](UploadResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/docs/UserGroupResponse.md

@@ -0,0 +1,19 @@
+# PulpcoreClient::UserGroupResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name. | 
+**pulp_href** | **String** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::UserGroupResponse.new(name: null,
+                                 pulp_href: null)
+```
+
+

data/docs/UserResponse.md

@@ -0,0 +1,35 @@
+# PulpcoreClient::UserResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**id** | **Integer** |  | [optional] [readonly] 
+**username** | **String** | Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. | 
+**first_name** | **String** | First name | 
+**last_name** | **String** | Last name | 
+**email** | **String** | Email address | 
+**is_staff** | **Boolean** | Designates whether the user can log into this admin site. | [optional] [default to false]
+**is_active** | **Boolean** | Designates whether this user should be treated as active. | [optional] [default to true]
+**date_joined** | **DateTime** | Date joined | [optional] [readonly] 
+**groups** | [**Array<UserGroupResponse>**](UserGroupResponse.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'PulpcoreClient'
+
+instance = PulpcoreClient::UserResponse.new(pulp_href: null,
+                                 id: null,
+                                 username: null,
+                                 first_name: null,
+                                 last_name: null,
+                                 email: null,
+                                 is_staff: null,
+                                 is_active: null,
+                                 date_joined: null,
+                                 groups: null)
+```
+
+

data/docs/UsersApi.md

@@ -0,0 +1,191 @@
+# PulpcoreClient::UsersApi
+
+All URIs are relative to *http://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](UsersApi.md#list) | **GET** /pulp/api/v3/users/ | List users
+[**permissions**](UsersApi.md#permissions) | **GET** {auth_user_href}permissions/ | 
+[**read**](UsersApi.md#read) | **GET** {auth_user_href} | Inspect an user
+
+
+
+## list
+
+> InlineResponse20013 list(opts)
+
+List users
+
+ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UsersApi.new
+opts = {
+  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', # String | Which field to use when ordering the results.
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #List users
+  result = api_instance.list(opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling UsersApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**InlineResponse20013**](InlineResponse20013.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## permissions
+
+> PermissionResponse permissions(auth_user_href, opts)
+
+
+
+List user permissions.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UsersApi.new
+auth_user_href = 'auth_user_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  result = api_instance.permissions(auth_user_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling UsersApi->permissions: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_user_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**PermissionResponse**](PermissionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> UserResponse read(auth_user_href, opts)
+
+Inspect an user
+
+ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+
+### Example
+
+```ruby
+# load the gem
+require 'pulpcore_client'
+# setup authorization
+PulpcoreClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpcoreClient::UsersApi.new
+auth_user_href = 'auth_user_href_example' # String | 
+opts = {
+  fields: 'fields_example', # String | A list of fields to include in the response.
+  exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
+}
+
+begin
+  #Inspect an user
+  result = api_instance.read(auth_user_href, opts)
+  p result
+rescue PulpcoreClient::ApiError => e
+  puts "Exception when calling UsersApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **auth_user_href** | **String**|  | 
+ **fields** | **String**| A list of fields to include in the response. | [optional] 
+ **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
+
+### Return type
+
+[**UserResponse**](UserResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{Version.md → VersionResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::Version
+# PulpcoreClient::VersionResponse
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::Version.new(component: null,
+instance = PulpcoreClient::VersionResponse.new(component: null,
                                  version: null)
 ```
 

data/docs/{Worker.md → WorkerResponse.md}

@@ -1,4 +1,4 @@
-# PulpcoreClient::Worker
+# PulpcoreClient::WorkerResponse
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpcoreClient'
 
-instance = PulpcoreClient::Worker.new(pulp_href: null,
+instance = PulpcoreClient::WorkerResponse.new(pulp_href: null,
                                  pulp_created: null,
                                  name: null,
                                  last_heartbeat: null)