pulp_ostree_client 2.0.0a1

data/docs/PaginatedostreeOstreeRemoteResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeRemoteResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeRemoteResponse>**](OstreeOstreeRemoteResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeRemoteResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedostreeOstreeRepositoryResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeRepositoryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeRepositoryResponse>**](OstreeOstreeRepositoryResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeRepositoryResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PaginatedostreeOstreeSummaryResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeSummaryResponse>**](OstreeOstreeSummaryResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList.new(count: 123,
+                                 _next: http://api.example.org/accounts/?offset=400&limit=100,
+                                 previous: http://api.example.org/accounts/?offset=200&limit=100,
+                                 results: null)
+```
+
+

data/docs/PatchedostreeOstreeDistribution.md

@@ -0,0 +1,27 @@
+# PulpOstreeClient::PatchedostreeOstreeDistribution
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**base_path** | **String** | The base (relative) path component of the published url. Avoid paths that                     overlap with other distribution base paths (e.g. \"foo\" and \"foo/bar\") | [optional] 
+**content_guard** | **String** | An optional content-guard. | [optional] 
+**pulp_labels** | [**Object**](.md) |  | [optional] 
+**name** | **String** | A unique name. Ex, `rawhide` and `stable`. | [optional] 
+**repository** | **String** | The latest RepositoryVersion for this Repository will be served. | [optional] 
+**repository_version** | **String** | RepositoryVersion to be served | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedostreeOstreeDistribution.new(base_path: null,
+                                 content_guard: null,
+                                 pulp_labels: null,
+                                 name: null,
+                                 repository: null,
+                                 repository_version: null)
+```
+
+

data/docs/PatchedostreeOstreeRemote.md

@@ -0,0 +1,59 @@
+# PulpOstreeClient::PatchedostreeOstreeRemote
+
+## 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 authenticte to the proxy. | [optional] 
+**username** | **String** | The username to be used for authentication when syncing. | [optional] 
+**password** | **String** | The password to be used for authentication when syncing. | [optional] 
+**pulp_labels** | [**Object**](.md) |  | [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) |          immediate - All OSTree objects are downloaded and saved during synchronization.         on_demand - Only commits, dirtrees, and refs are downloaded. Other OSTree objects are                     not downloaded until they are requested for the first time by a client.          | [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 total download rate in requests per second | [optional] 
+**depth** | **Integer** | An option to specify how many commits to traverse. | [optional] [default to 0]
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedostreeOstreeRemote.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,
+                                 depth: null)
+```
+
+

data/docs/PatchedostreeOstreeRepository.md

@@ -0,0 +1,25 @@
+# PulpOstreeClient::PatchedostreeOstreeRepository
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_labels** | [**Object**](.md) |  | [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. This is provided as a tech preview in Pulp 3 and may change in the future. | [optional] 
+**remote** | **String** | An optional remote to use by default when syncing. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PatchedostreeOstreeRepository.new(pulp_labels: null,
+                                 name: null,
+                                 description: null,
+                                 retain_repo_versions: null,
+                                 remote: null)
+```
+
+

data/docs/PolicyEnum.md

@@ -0,0 +1,16 @@
+# PulpOstreeClient::PolicyEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PolicyEnum.new()
+```
+
+

data/docs/RemotesOstreeApi.md

@@ -0,0 +1,376 @@
+# PulpOstreeClient::RemotesOstreeApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create**](RemotesOstreeApi.md#create) | **POST** /pulp/api/v3/remotes/ostree/ostree/ | Create an ostree remote
+[**delete**](RemotesOstreeApi.md#delete) | **DELETE** {ostree_ostree_remote_href} | Delete an ostree remote
+[**list**](RemotesOstreeApi.md#list) | **GET** /pulp/api/v3/remotes/ostree/ostree/ | List ostree remotes
+[**partial_update**](RemotesOstreeApi.md#partial_update) | **PATCH** {ostree_ostree_remote_href} | Update an ostree remote
+[**read**](RemotesOstreeApi.md#read) | **GET** {ostree_ostree_remote_href} | Inspect an ostree remote
+[**update**](RemotesOstreeApi.md#update) | **PUT** {ostree_ostree_remote_href} | Update an ostree remote
+
+
+
+## create
+
+> OstreeOstreeRemoteResponse create(ostree_ostree_remote)
+
+Create an ostree remote
+
+A ViewSet class for OSTree remote repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+ostree_ostree_remote = PulpOstreeClient::OstreeOstreeRemote.new # OstreeOstreeRemote | 
+
+begin
+  #Create an ostree remote
+  result = api_instance.create(ostree_ostree_remote)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->create: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_remote** | [**OstreeOstreeRemote**](OstreeOstreeRemote.md)|  | 
+
+### Return type
+
+[**OstreeOstreeRemoteResponse**](OstreeOstreeRemoteResponse.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
+
+> AsyncOperationResponse delete(ostree_ostree_remote_href)
+
+Delete an ostree remote
+
+Trigger an asynchronous delete task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+ostree_ostree_remote_href = 'ostree_ostree_remote_href_example' # String | 
+
+begin
+  #Delete an ostree remote
+  result = api_instance.delete(ostree_ostree_remote_href)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_remote_href** | **String**|  | 
+
+### Return type
+
+[**AsyncOperationResponse**](AsyncOperationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list
+
+> PaginatedostreeOstreeRemoteResponseList list(opts)
+
+List ostree remotes
+
+A ViewSet class for OSTree remote repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+opts = {
+  limit: 56, # Integer | Number of results to return per page.
+  name: 'name_example', # String | 
+  name__contains: 'name__contains_example', # String | Filter results where name contains value
+  name__icontains: 'name__icontains_example', # String | Filter results where name contains value
+  name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  name__startswith: 'name__startswith_example', # String | Filter results where name starts with value
+  offset: 56, # Integer | The initial index from which to return the results.
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
+  pulp_last_updated: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | ISO 8601 formatted dates are supported
+  pulp_last_updated__gt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than value
+  pulp_last_updated__gte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is greater than or equal to value
+  pulp_last_updated__lt: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than value
+  pulp_last_updated__lte: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter results where pulp_last_updated is less than or equal to value
+  pulp_last_updated__range: [DateTime.parse('2013-10-20T19:20:30+01:00')], # Array<DateTime> | Filter results where pulp_last_updated is between two comma separated values
+  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 ostree remotes
+  result = api_instance.list(opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **name** | **String**|  | [optional] 
+ **name__contains** | **String**| Filter results where name contains value | [optional] 
+ **name__icontains** | **String**| Filter results where name contains value | [optional] 
+ **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] 
+ **name__startswith** | **String**| Filter results where name starts with value | [optional] 
+ **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
+ **pulp_label_select** | **String**| Filter labels by search string | [optional] 
+ **pulp_last_updated** | **DateTime**| ISO 8601 formatted dates are supported | [optional] 
+ **pulp_last_updated__gt** | **DateTime**| Filter results where pulp_last_updated is greater than value | [optional] 
+ **pulp_last_updated__gte** | **DateTime**| Filter results where pulp_last_updated is greater than or equal to value | [optional] 
+ **pulp_last_updated__lt** | **DateTime**| Filter results where pulp_last_updated is less than value | [optional] 
+ **pulp_last_updated__lte** | **DateTime**| Filter results where pulp_last_updated is less than or equal to value | [optional] 
+ **pulp_last_updated__range** | [**Array&lt;DateTime&gt;**](DateTime.md)| Filter results where pulp_last_updated is between two comma separated values | [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
+
+[**PaginatedostreeOstreeRemoteResponseList**](PaginatedostreeOstreeRemoteResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## partial_update
+
+> AsyncOperationResponse partial_update(ostree_ostree_remote_href, patchedostree_ostree_remote)
+
+Update an ostree remote
+
+Trigger an asynchronous partial update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+ostree_ostree_remote_href = 'ostree_ostree_remote_href_example' # String | 
+patchedostree_ostree_remote = PulpOstreeClient::PatchedostreeOstreeRemote.new # PatchedostreeOstreeRemote | 
+
+begin
+  #Update an ostree remote
+  result = api_instance.partial_update(ostree_ostree_remote_href, patchedostree_ostree_remote)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->partial_update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_remote_href** | **String**|  | 
+ **patchedostree_ostree_remote** | [**PatchedostreeOstreeRemote**](PatchedostreeOstreeRemote.md)|  | 
+
+### 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
+
+
+## read
+
+> OstreeOstreeRemoteResponse read(ostree_ostree_remote_href, opts)
+
+Inspect an ostree remote
+
+A ViewSet class for OSTree remote repositories.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+ostree_ostree_remote_href = 'ostree_ostree_remote_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 ostree remote
+  result = api_instance.read(ostree_ostree_remote_href, opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_remote_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
+
+[**OstreeOstreeRemoteResponse**](OstreeOstreeRemoteResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update
+
+> AsyncOperationResponse update(ostree_ostree_remote_href, ostree_ostree_remote)
+
+Update an ostree remote
+
+Trigger an asynchronous update task
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ostree_client'
+# setup authorization
+PulpOstreeClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpOstreeClient::RemotesOstreeApi.new
+ostree_ostree_remote_href = 'ostree_ostree_remote_href_example' # String | 
+ostree_ostree_remote = PulpOstreeClient::OstreeOstreeRemote.new # OstreeOstreeRemote | 
+
+begin
+  #Update an ostree remote
+  result = api_instance.update(ostree_ostree_remote_href, ostree_ostree_remote)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RemotesOstreeApi->update: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_remote_href** | **String**|  | 
+ **ostree_ostree_remote** | [**OstreeOstreeRemote**](OstreeOstreeRemote.md)|  | 
+
+### 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
+