pulp_hugging_face_client 0.0.1

data/docs/RepositoriesHuggingFaceVersionsApi.md

@@ -0,0 +1,359 @@
+# PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi
+
+All URIs are relative to *http://localhost:24817*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete**](RepositoriesHuggingFaceVersionsApi.md#delete) | **DELETE** {hugging_face_hugging_face_repository_version_href} | Delete a repository version |
+| [**list**](RepositoriesHuggingFaceVersionsApi.md#list) | **GET** {hugging_face_hugging_face_repository_href}versions/ | List repository versions |
+| [**read**](RepositoriesHuggingFaceVersionsApi.md#read) | **GET** {hugging_face_hugging_face_repository_version_href} | Inspect a repository version |
+| [**repair**](RepositoriesHuggingFaceVersionsApi.md#repair) | **POST** {hugging_face_hugging_face_repository_version_href}repair/ |  |
+
+
+## delete
+
+> <AsyncOperationResponse> delete(hugging_face_hugging_face_repository_version_href, opts)
+
+Delete a repository version
+
+Trigger an asynchronous task to delete a repository version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_hugging_face_client'
+# setup authorization
+PulpHuggingFaceClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi.new
+hugging_face_hugging_face_repository_version_href = 'hugging_face_hugging_face_repository_version_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  # Delete a repository version
+  result = api_instance.delete(hugging_face_hugging_face_repository_version_href, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->delete: #{e}"
+end
+```
+
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> delete_with_http_info(hugging_face_hugging_face_repository_version_href, opts)
+
+```ruby
+begin
+  # Delete a repository version
+  data, status_code, headers = api_instance.delete_with_http_info(hugging_face_hugging_face_repository_version_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_repository_version_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> <PaginatedRepositoryVersionResponseList> list(hugging_face_hugging_face_repository_href, opts)
+
+List repository versions
+
+A ViewSet for a HuggingFaceRepositoryVersion represents a single HuggingFace repository version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_hugging_face_client'
+# setup authorization
+PulpHuggingFaceClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi.new
+hugging_face_hugging_face_repository_href = 'hugging_face_hugging_face_repository_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  content: 'content_example', # String | Content Unit referenced by HREF/PRN
+  content__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  limit: 56, # Integer | Number of results to return per page.
+  number: 56, # Integer | Filter results where number matches value
+  number__gt: 56, # Integer | Filter results where number is greater than value
+  number__gte: 56, # Integer | Filter results where number is greater than or equal to value
+  number__lt: 56, # Integer | Filter results where number is less than value
+  number__lte: 56, # Integer | Filter results where number is less than or equal to value
+  number__range: [37], # Array<Integer> | Filter results where number is between two comma separated values
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['-complete'], # Array<String> | Ordering  * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `number` - Number * `-number` - Number (descending) * `complete` - Complete * `-complete` - Complete (descending) * `info` - Info * `-info` - Info (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  pulp_created: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created matches value
+  pulp_created__gt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than value
+  pulp_created__gte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is greater than or equal to value
+  pulp_created__isnull: true, # Boolean | Filter results where pulp_created has a null value
+  pulp_created__lt: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than value
+  pulp_created__lte: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter results where pulp_created is less than or equal to value
+  pulp_created__range: [Time.now], # Array<Time> | Filter results where pulp_created is between two comma separated values
+  pulp_href__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
+  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 repository versions
+  result = api_instance.list(hugging_face_hugging_face_repository_href, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedRepositoryVersionResponseList>, Integer, Hash)> list_with_http_info(hugging_face_hugging_face_repository_href, opts)
+
+```ruby
+begin
+  # List repository versions
+  data, status_code, headers = api_instance.list_with_http_info(hugging_face_hugging_face_repository_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedRepositoryVersionResponseList>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_repository_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+| **content** | **String** | Content Unit referenced by HREF/PRN | [optional] |
+| **content__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **number** | **Integer** | Filter results where number matches value | [optional] |
+| **number__gt** | **Integer** | Filter results where number is greater than value | [optional] |
+| **number__gte** | **Integer** | Filter results where number is greater than or equal to value | [optional] |
+| **number__lt** | **Integer** | Filter results where number is less than value | [optional] |
+| **number__lte** | **Integer** | Filter results where number is less than or equal to value | [optional] |
+| **number__range** | [**Array&lt;Integer&gt;**](Integer.md) | Filter results where number is between two comma separated values | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **ordering** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;number&#x60; - Number * &#x60;-number&#x60; - Number (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;info&#x60; - Info * &#x60;-info&#x60; - Info (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_created** | **Time** | Filter results where pulp_created matches value | [optional] |
+| **pulp_created__gt** | **Time** | Filter results where pulp_created is greater than value | [optional] |
+| **pulp_created__gte** | **Time** | Filter results where pulp_created is greater than or equal to value | [optional] |
+| **pulp_created__isnull** | **Boolean** | Filter results where pulp_created has a null value | [optional] |
+| **pulp_created__lt** | **Time** | Filter results where pulp_created is less than value | [optional] |
+| **pulp_created__lte** | **Time** | Filter results where pulp_created is less than or equal to value | [optional] |
+| **pulp_created__range** | [**Array&lt;Time&gt;**](Time.md) | Filter results where pulp_created is between two comma separated values | [optional] |
+| **pulp_href__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] |
+| **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
+
+[**PaginatedRepositoryVersionResponseList**](PaginatedRepositoryVersionResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> <RepositoryVersionResponse> read(hugging_face_hugging_face_repository_version_href, opts)
+
+Inspect a repository version
+
+A ViewSet for a HuggingFaceRepositoryVersion represents a single HuggingFace repository version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_hugging_face_client'
+# setup authorization
+PulpHuggingFaceClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi.new
+hugging_face_hugging_face_repository_version_href = 'hugging_face_hugging_face_repository_version_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  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 a repository version
+  result = api_instance.read(hugging_face_hugging_face_repository_version_href, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->read: #{e}"
+end
+```
+
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RepositoryVersionResponse>, Integer, Hash)> read_with_http_info(hugging_face_hugging_face_repository_version_href, opts)
+
+```ruby
+begin
+  # Inspect a repository version
+  data, status_code, headers = api_instance.read_with_http_info(hugging_face_hugging_face_repository_version_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RepositoryVersionResponse>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_repository_version_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [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
+
+[**RepositoryVersionResponse**](RepositoryVersionResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## repair
+
+> <AsyncOperationResponse> repair(hugging_face_hugging_face_repository_version_href, repair, opts)
+
+
+
+Trigger an asynchronous task to repair a repository version.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_hugging_face_client'
+# setup authorization
+PulpHuggingFaceClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi.new
+hugging_face_hugging_face_repository_version_href = 'hugging_face_hugging_face_repository_version_href_example' # String | 
+repair = PulpHuggingFaceClient::Repair.new # Repair | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  
+  result = api_instance.repair(hugging_face_hugging_face_repository_version_href, repair, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->repair: #{e}"
+end
+```
+
+#### Using the repair_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> repair_with_http_info(hugging_face_hugging_face_repository_version_href, repair, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.repair_with_http_info(hugging_face_hugging_face_repository_version_href, repair, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling RepositoriesHuggingFaceVersionsApi->repair_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_repository_version_href** | **String** |  |  |
+| **repair** | [**Repair**](Repair.md) |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/RepositoryAddRemoveContent.md

@@ -0,0 +1,22 @@
+# PulpHuggingFaceClient::RepositoryAddRemoveContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_content_units** | **Array<String>** | A list of content units to add to a new repository version. This content is added after remove_content_units are removed. | [optional] |
+| **remove_content_units** | **Array<String>** | A list of content units to remove from the latest repository version. You may also specify '*' as an entry to remove all content. This content is removed before add_content_units are added. | [optional] |
+| **base_version** | **String** | A repository version whose content will be used as the initial set of content for the new repository version | [optional] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::RepositoryAddRemoveContent.new(
+  add_content_units: null,
+  remove_content_units: null,
+  base_version: null
+)
+```
+

data/docs/RepositorySyncURL.md

@@ -0,0 +1,20 @@
+# PulpHuggingFaceClient::RepositorySyncURL
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **remote** | **String** | A remote to sync from. This will override a remote set on repository. | [optional] |
+| **mirror** | **Boolean** | If ``True``, synchronization will remove all content that is not present in the remote repository. If ``False``, sync will be additive only. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::RepositorySyncURL.new(
+  remote: null,
+  mirror: null
+)
+```
+

data/docs/RepositoryVersionResponse.md

@@ -0,0 +1,32 @@
+# PulpHuggingFaceClient::RepositoryVersionResponse
+
+## Properties
+
+| 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] |
+| **number** | **Integer** |  | [optional][readonly] |
+| **repository** | **String** |  | [optional][readonly] |
+| **base_version** | **String** | A repository version whose content was used as the initial set of content for this repository version | [optional] |
+| **content_summary** | [**ContentSummaryResponse**](ContentSummaryResponse.md) | Various count summaries of the content in the version and the HREF to view them. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::RepositoryVersionResponse.new(
+  pulp_href: null,
+  prn: null,
+  pulp_created: null,
+  pulp_last_updated: null,
+  number: null,
+  repository: null,
+  base_version: null,
+  content_summary: null
+)
+```
+

data/docs/SetLabel.md

@@ -0,0 +1,20 @@
+# PulpHuggingFaceClient::SetLabel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::SetLabel.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/SetLabelResponse.md

@@ -0,0 +1,20 @@
+# PulpHuggingFaceClient::SetLabelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::SetLabelResponse.new(
+  key: null,
+  value: null
+)
+```
+

data/docs/UnsetLabel.md

@@ -0,0 +1,18 @@
+# PulpHuggingFaceClient::UnsetLabel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::UnsetLabel.new(
+  key: null
+)
+```
+

data/docs/UnsetLabelResponse.md

@@ -0,0 +1,20 @@
+# PulpHuggingFaceClient::UnsetLabelResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  |  |
+| **value** | **String** |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::UnsetLabelResponse.new(
+  key: null,
+  value: null
+)
+```
+