pulp_ostree_client 2.0.0a1.dev1626751709 → 2.0.0a1.dev1631416829

data/docs/OstreeOstreeRefResponse.md

@@ -0,0 +1,25 @@
+# PulpOstreeClient::OstreeOstreeRefResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pulp_href** | **String** |  | [optional] [readonly] 
+**pulp_created** | **DateTime** | Timestamp of creation. | [optional] [readonly] 
+**artifact** | **String** | Artifact file representing the physical content | 
+**commit** | **String** |  | 
+**name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::OstreeOstreeRefResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null,
+                                 commit: null,
+                                 name: null)
+```
+
+

data/docs/OstreeOstreeRemote.md

@@ -18,13 +18,14 @@ Name | Type | Description | Notes
 **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) | The policy to use when downloading content. | [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
 
@@ -51,7 +52,8 @@ instance = PulpOstreeClient::OstreeOstreeRemote.new(name: null,
                                  sock_connect_timeout: null,
                                  sock_read_timeout: null,
                                  headers: null,
-                                 rate_limit: null)
+                                 rate_limit: null,
+                                 depth: null)
 ```
 
 

data/docs/OstreeOstreeRemoteResponse.md

@@ -16,13 +16,14 @@ Name | Type | Description | Notes
 **pulp_last_updated** | **DateTime** | Timestamp of the most recent update of the remote. | [optional] [readonly] 
 **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. | [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
 
@@ -47,7 +48,8 @@ instance = PulpOstreeClient::OstreeOstreeRemoteResponse.new(pulp_href: null,
                                  sock_connect_timeout: null,
                                  sock_read_timeout: null,
                                  headers: null,
-                                 rate_limit: null)
+                                 rate_limit: null,
+                                 depth: null)
 ```
 
 

data/docs/OstreeOstreeRepository.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **name** | **String** | A unique name for this repository. | 
 **description** | **String** | An optional description. | [optional] 
-**retained_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** |  | [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
 
@@ -18,7 +18,7 @@ require 'PulpOstreeClient'
 instance = PulpOstreeClient::OstreeOstreeRepository.new(pulp_labels: null,
                                  name: null,
                                  description: null,
-                                 retained_versions: null,
+                                 retain_repo_versions: null,
                                  remote: null)
 ```
 

data/docs/OstreeOstreeRepositoryResponse.md

@@ -11,8 +11,8 @@ Name | Type | Description | Notes
 **latest_version_href** | **String** |  | [optional] [readonly] 
 **name** | **String** | A unique name for this repository. | 
 **description** | **String** | An optional description. | [optional] 
-**retained_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** |  | [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
 
@@ -26,7 +26,7 @@ instance = PulpOstreeClient::OstreeOstreeRepositoryResponse.new(pulp_href: null,
                                  latest_version_href: null,
                                  name: null,
                                  description: null,
-                                 retained_versions: null,
+                                 retain_repo_versions: null,
                                  remote: null)
 ```
 

data/docs/{OstreeOstreeContentResponse.md → OstreeOstreeSummaryResponse.md}

@@ -1,4 +1,4 @@
-# PulpOstreeClient::OstreeOstreeContentResponse
+# PulpOstreeClient::OstreeOstreeSummaryResponse
 
 ## Properties
 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'PulpOstreeClient'
 
-instance = PulpOstreeClient::OstreeOstreeContentResponse.new(pulp_href: null,
+instance = PulpOstreeClient::OstreeOstreeSummaryResponse.new(pulp_href: null,
                                  pulp_created: null,
                                  artifact: null)
 ```

data/docs/OstreeRepoImport.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::OstreeRepoImport
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**artifact** | **String** | An artifact representing OSTree content compressed as a tarball. | 
+**repository_name** | **String** | The name of a repository that contains the compressed OSTree content. | 
+**ref** | **String** | The name of a ref branch that holds the reference to the last commit. | [optional] 
+**parent_commit** | **String** | The checksum of a parent commit with which the content needs to be associated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::OstreeRepoImport.new(artifact: null,
+                                 repository_name: null,
+                                 ref: null,
+                                 parent_commit: null)
+```
+
+

data/docs/{PaginatedostreeOstreePublicationResponseList.md → PaginatedostreeOstreeCommitResponseList.md}

@@ -1,4 +1,4 @@
-# PulpOstreeClient::PaginatedostreeOstreePublicationResponseList
+# PulpOstreeClient::PaginatedostreeOstreeCommitResponseList
 
 ## Properties
 
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | [optional] 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<OstreeOstreePublicationResponse>**](OstreeOstreePublicationResponse.md) |  | [optional] 
+**results** | [**Array<OstreeOstreeCommitResponse>**](OstreeOstreeCommitResponse.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpOstreeClient'
 
-instance = PulpOstreeClient::PaginatedostreeOstreePublicationResponseList.new(count: 123,
+instance = PulpOstreeClient::PaginatedostreeOstreeCommitResponseList.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/PaginatedostreeOstreeConfigResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeConfigResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeConfigResponse>**](OstreeOstreeConfigResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeConfigResponseList.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/PaginatedostreeOstreeObjectResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeObjectResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeObjectResponse>**](OstreeOstreeObjectResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeObjectResponseList.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/PaginatedostreeOstreeRefResponseList.md

@@ -0,0 +1,23 @@
+# PulpOstreeClient::PaginatedostreeOstreeRefResponseList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**_next** | **String** |  | [optional] 
+**previous** | **String** |  | [optional] 
+**results** | [**Array<OstreeOstreeRefResponse>**](OstreeOstreeRefResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::PaginatedostreeOstreeRefResponseList.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/{PaginatedostreeOstreeContentResponseList.md → PaginatedostreeOstreeSummaryResponseList.md}

@@ -1,4 +1,4 @@
-# PulpOstreeClient::PaginatedostreeOstreeContentResponseList
+# PulpOstreeClient::PaginatedostreeOstreeSummaryResponseList
 
 ## Properties
 
@@ -7,14 +7,14 @@ Name | Type | Description | Notes
 **count** | **Integer** |  | [optional] 
 **_next** | **String** |  | [optional] 
 **previous** | **String** |  | [optional] 
-**results** | [**Array<OstreeOstreeContentResponse>**](OstreeOstreeContentResponse.md) |  | [optional] 
+**results** | [**Array<OstreeOstreeSummaryResponse>**](OstreeOstreeSummaryResponse.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'PulpOstreeClient'
 
-instance = PulpOstreeClient::PaginatedostreeOstreeContentResponseList.new(count: 123,
+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

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **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] 
-**publication** | **String** | Publication to be served | [optional] 
+**repository_version** | **String** | RepositoryVersion to be served | [optional] 
 
 ## Code Sample
 
@@ -21,7 +21,7 @@ instance = PulpOstreeClient::PatchedostreeOstreeDistribution.new(base_path: null
                                  pulp_labels: null,
                                  name: null,
                                  repository: null,
-                                 publication: null)
+                                 repository_version: null)
 ```
 
 

data/docs/PatchedostreeOstreeRemote.md

@@ -18,13 +18,14 @@ Name | Type | Description | Notes
 **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) | The policy to use when downloading content. | [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
 
@@ -51,7 +52,8 @@ instance = PulpOstreeClient::PatchedostreeOstreeRemote.new(name: null,
                                  sock_connect_timeout: null,
                                  sock_read_timeout: null,
                                  headers: null,
-                                 rate_limit: null)
+                                 rate_limit: null,
+                                 depth: null)
 ```
 
 

data/docs/PatchedostreeOstreeRepository.md

@@ -7,8 +7,8 @@ Name | Type | Description | Notes
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **name** | **String** | A unique name for this repository. | [optional] 
 **description** | **String** | An optional description. | [optional] 
-**retained_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** |  | [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
 
@@ -18,7 +18,7 @@ require 'PulpOstreeClient'
 instance = PulpOstreeClient::PatchedostreeOstreeRepository.new(pulp_labels: null,
                                  name: null,
                                  description: null,
-                                 retained_versions: null,
+                                 retain_repo_versions: null,
                                  remote: null)
 ```
 

data/docs/RemotesOstreeApi.md

@@ -1,6 +1,6 @@
 # PulpOstreeClient::RemotesOstreeApi
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -19,7 +19,7 @@ Method | HTTP request | Description
 
 Create an ostree remote
 
-A ViewSet for OstreeRemote.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree remote repositories.
 
 ### Example
 
@@ -125,7 +125,7 @@ Name | Type | Description  | Notes
 
 List ostree remotes
 
-A ViewSet for OstreeRemote.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree remote repositories.
 
 ### Example
 
@@ -267,7 +267,7 @@ Name | Type | Description  | Notes
 
 Inspect an ostree remote
 
-A ViewSet for OstreeRemote.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree remote repositories.
 
 ### Example
 

data/docs/RepositoriesOstreeApi.md

@@ -1,11 +1,12 @@
 # PulpOstreeClient::RepositoriesOstreeApi
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**create**](RepositoriesOstreeApi.md#create) | **POST** /pulp/api/v3/repositories/ostree/ostree/ | Create an ostree repository
 [**delete**](RepositoriesOstreeApi.md#delete) | **DELETE** {ostree_ostree_repository_href} | Delete an ostree repository
+[**import_commits**](RepositoriesOstreeApi.md#import_commits) | **POST** {ostree_ostree_repository_href}import_commits/ | Import commits to a repository
 [**list**](RepositoriesOstreeApi.md#list) | **GET** /pulp/api/v3/repositories/ostree/ostree/ | List ostree repositorys
 [**modify**](RepositoriesOstreeApi.md#modify) | **POST** {ostree_ostree_repository_href}modify/ | Modify Repository Content
 [**partial_update**](RepositoriesOstreeApi.md#partial_update) | **PATCH** {ostree_ostree_repository_href} | Update an ostree repository
@@ -21,7 +22,7 @@ Method | HTTP request | Description
 
 Create an ostree repository
 
-A ViewSet for OstreeRepository.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree repositories.
 
 ### Example
 
@@ -121,13 +122,68 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## import_commits
+
+> AsyncOperationResponse import_commits(ostree_ostree_repository_href, ostree_repo_import)
+
+Import commits to a repository
+
+Trigger an asynchronous task to create a new OSTree repository version.
+
+### 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::RepositoriesOstreeApi.new
+ostree_ostree_repository_href = 'ostree_ostree_repository_href_example' # String | 
+ostree_repo_import = PulpOstreeClient::OstreeRepoImport.new # OstreeRepoImport | 
+
+begin
+  #Import commits to a repository
+  result = api_instance.import_commits(ostree_ostree_repository_href, ostree_repo_import)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling RepositoriesOstreeApi->import_commits: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_repository_href** | **String**|  | 
+ **ostree_repo_import** | [**OstreeRepoImport**](OstreeRepoImport.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
+
+
 ## list
 
 > PaginatedostreeOstreeRepositoryResponseList list(opts)
 
 List ostree repositorys
 
-A ViewSet for OstreeRepository.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree repositories.
 
 ### Example
 
@@ -312,7 +368,7 @@ Name | Type | Description  | Notes
 
 Inspect an ostree repository
 
-A ViewSet for OstreeRepository.  Similar to the OstreeContentViewSet above, define endpoint_name, queryset and serializer, at a minimum.
+A ViewSet class for OSTree repositories.
 
 ### Example