pulp_hugging_face_client 0.0.1

data/docs/PatchedhuggingFaceHuggingFaceRemote.md

@@ -0,0 +1,62 @@
+# PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRemote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A unique name for this remote. | [optional] |
+| **url** | **String** | The URL of an external content source. | [optional] |
+| **ca_cert** | **String** | A PEM encoded CA certificate used to validate the server certificate presented by the remote server. | [optional] |
+| **client_cert** | **String** | A PEM encoded client certificate used for authentication. | [optional] |
+| **client_key** | **String** | A PEM encoded private key used for authentication. | [optional] |
+| **tls_validation** | **Boolean** | If True, TLS peer validation must be performed. | [optional] |
+| **proxy_url** | **String** | The proxy URL. Format: scheme://host:port | [optional] |
+| **proxy_username** | **String** | The username to authenticte to the proxy. | [optional] |
+| **proxy_password** | **String** | The password to authenticate to the proxy. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **username** | **String** | The username to be used for authentication when syncing. | [optional] |
+| **password** | **String** | The password to be used for authentication when syncing. Extra leading and trailing whitespace characters are not trimmed. | [optional] |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **download_concurrency** | **Integer** | Total number of simultaneous connections. If not set then the default value will be used. | [optional] |
+| **max_retries** | **Integer** | Maximum number of retry attempts after a download failure. If not set then the default value (3) will be used. | [optional] |
+| **policy** | [**PolicyEnum**](PolicyEnum.md) | The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' enables pull-through caching.  * `immediate` - When syncing, download all metadata and content now. * `on_demand` - When syncing, download metadata, but do not download content now. Instead, download content as clients request it, and save it in Pulp to be served for future client requests. * `streamed` - When syncing, download metadata, but do not download content now. Instead,download content as clients request it, but never save it in Pulp. This causes future requests for that same content to have to be downloaded again. | [optional] |
+| **total_timeout** | **Float** | aiohttp.ClientTimeout.total (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **connect_timeout** | **Float** | aiohttp.ClientTimeout.connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_connect_timeout** | **Float** | aiohttp.ClientTimeout.sock_connect (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **sock_read_timeout** | **Float** | aiohttp.ClientTimeout.sock_read (q.v.) for download-connections. The default is null, which will cause the default from the aiohttp library to be used. | [optional] |
+| **headers** | **Array<Object>** | Headers for aiohttp.Clientsession | [optional] |
+| **rate_limit** | **Integer** | Limits requests per second for each concurrent downloader | [optional] |
+| **hf_hub_url** | **String** | Base URL for Hugging Face Hub | [optional][default to 'https://huggingface.co'] |
+| **hf_token** | **String** | Hugging Face authentication token for private repositories | [optional] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRemote.new(
+  name: null,
+  url: null,
+  ca_cert: null,
+  client_cert: null,
+  client_key: null,
+  tls_validation: null,
+  proxy_url: null,
+  proxy_username: null,
+  proxy_password: null,
+  username: null,
+  password: null,
+  pulp_labels: null,
+  download_concurrency: null,
+  max_retries: null,
+  policy: null,
+  total_timeout: null,
+  connect_timeout: null,
+  sock_connect_timeout: null,
+  sock_read_timeout: null,
+  headers: null,
+  rate_limit: null,
+  hf_hub_url: null,
+  hf_token: null
+)
+```
+

data/docs/PatchedhuggingFaceHuggingFaceRepository.md

@@ -0,0 +1,26 @@
+# PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRepository
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pulp_labels** | **Hash<String, String>** |  | [optional] |
+| **name** | **String** | A unique name for this repository. | [optional] |
+| **description** | **String** | An optional description. | [optional] |
+| **retain_repo_versions** | **Integer** | Retain X versions of the repository. Default is null which retains all versions. | [optional] |
+| **remote** | **String** | An optional remote to use by default when syncing. | [optional] |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRepository.new(
+  pulp_labels: null,
+  name: null,
+  description: null,
+  retain_repo_versions: null,
+  remote: null
+)
+```
+

data/docs/PolicyEnum.md

@@ -0,0 +1,15 @@
+# PulpHuggingFaceClient::PolicyEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pulp_hugging_face_client'
+
+instance = PulpHuggingFaceClient::PolicyEnum.new()
+```
+

data/docs/PublicationsHuggingFaceApi.md

@@ -0,0 +1,350 @@
+# PulpHuggingFaceClient::PublicationsHuggingFaceApi
+
+All URIs are relative to *http://localhost:24817*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](PublicationsHuggingFaceApi.md#create) | **POST** /pulp/api/v3/publications/hugging_face/hugging-face/ | Create a hugging face publication |
+| [**delete**](PublicationsHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_publication_href} | Delete a hugging face publication |
+| [**list**](PublicationsHuggingFaceApi.md#list) | **GET** /pulp/api/v3/publications/hugging_face/hugging-face/ | List hugging face publications |
+| [**read**](PublicationsHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_publication_href} | Inspect a hugging face publication |
+
+
+## create
+
+> <AsyncOperationResponse> create(hugging_face_hugging_face_publication, opts)
+
+Create a hugging face publication
+
+Trigger an asynchronous task to publish content
+
+### 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::PublicationsHuggingFaceApi.new
+hugging_face_hugging_face_publication = PulpHuggingFaceClient::HuggingFaceHuggingFacePublication.new # HuggingFaceHuggingFacePublication | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  # Create a hugging face publication
+  result = api_instance.create(hugging_face_hugging_face_publication, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->create: #{e}"
+end
+```
+
+#### Using the create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AsyncOperationResponse>, Integer, Hash)> create_with_http_info(hugging_face_hugging_face_publication, opts)
+
+```ruby
+begin
+  # Create a hugging face publication
+  data, status_code, headers = api_instance.create_with_http_info(hugging_face_hugging_face_publication, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_publication** | [**HuggingFaceHuggingFacePublication**](HuggingFaceHuggingFacePublication.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
+
+
+## delete
+
+> delete(hugging_face_hugging_face_publication_href, opts)
+
+Delete a hugging face publication
+
+A ViewSet for HuggingFacePublication.  Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### 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::PublicationsHuggingFaceApi.new
+hugging_face_hugging_face_publication_href = 'hugging_face_hugging_face_publication_href_example' # String | 
+opts = {
+  x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
+}
+
+begin
+  # Delete a hugging face publication
+  api_instance.delete(hugging_face_hugging_face_publication_href, opts)
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->delete: #{e}"
+end
+```
+
+#### 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(hugging_face_hugging_face_publication_href, opts)
+
+```ruby
+begin
+  # Delete a hugging face publication
+  data, status_code, headers = api_instance.delete_with_http_info(hugging_face_hugging_face_publication_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_publication_href** | **String** |  |  |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## list
+
+> <PaginatedhuggingFaceHuggingFacePublicationResponseList> list(opts)
+
+List hugging face publications
+
+A ViewSet for HuggingFacePublication.  Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### 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::PublicationsHuggingFaceApi.new
+opts = {
+  x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
+  checkpoint: true, # Boolean | Filter results where checkpoint matches value
+  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.
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: ['-checkpoint'], # 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) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `complete` - Complete * `-complete` - Complete (descending) * `pass_through` - Pass through * `-pass_through` - Pass through (descending) * `checkpoint` - Checkpoint * `-checkpoint` - Checkpoint (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.
+  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
+  repository: 'repository_example', # String | Repository referenced by HREF/PRN
+  repository_version: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Repository Version referenced by HREF/PRN
+  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 hugging face publications
+  result = api_instance.list(opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginatedhuggingFaceHuggingFacePublicationResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List hugging face publications
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedhuggingFaceHuggingFacePublicationResponseList>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_task_diagnostics** | [**Array&lt;String&gt;**](String.md) | List of profilers to use on tasks. | [optional] |
+| **checkpoint** | **Boolean** | Filter results where checkpoint matches value | [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] |
+| **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;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;complete&#x60; - Complete * &#x60;-complete&#x60; - Complete (descending) * &#x60;pass_through&#x60; - Pass through * &#x60;-pass_through&#x60; - Pass through (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (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] |
+| **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] |
+| **repository** | **String** | Repository referenced by HREF/PRN | [optional] |
+| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [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
+
+[**PaginatedhuggingFaceHuggingFacePublicationResponseList**](PaginatedhuggingFaceHuggingFacePublicationResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> <HuggingFaceHuggingFacePublicationResponse> read(hugging_face_hugging_face_publication_href, opts)
+
+Inspect a hugging face publication
+
+A ViewSet for HuggingFacePublication.  Similar to the HuggingFaceContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+
+### 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::PublicationsHuggingFaceApi.new
+hugging_face_hugging_face_publication_href = 'hugging_face_hugging_face_publication_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 hugging face publication
+  result = api_instance.read(hugging_face_hugging_face_publication_href, opts)
+  p result
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->read: #{e}"
+end
+```
+
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HuggingFaceHuggingFacePublicationResponse>, Integer, Hash)> read_with_http_info(hugging_face_hugging_face_publication_href, opts)
+
+```ruby
+begin
+  # Inspect a hugging face publication
+  data, status_code, headers = api_instance.read_with_http_info(hugging_face_hugging_face_publication_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HuggingFaceHuggingFacePublicationResponse>
+rescue PulpHuggingFaceClient::ApiError => e
+  puts "Error when calling PublicationsHuggingFaceApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **hugging_face_hugging_face_publication_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
+
+[**HuggingFaceHuggingFacePublicationResponse**](HuggingFaceHuggingFacePublicationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+