pulp_ostree_client 2.0.0a1.dev1626751709 → 2.0.0a1.dev1631416829

data/docs/ContentRefsApi.md

@@ -0,0 +1,138 @@
+# PulpOstreeClient::ContentRefsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](ContentRefsApi.md#list) | **GET** /pulp/api/v3/content/ostree/refs/ | List ostree refs
+[**read**](ContentRefsApi.md#read) | **GET** {ostree_ostree_ref_href} | Inspect an ostree ref
+
+
+
+## list
+
+> PaginatedostreeOstreeRefResponseList list(opts)
+
+List ostree refs
+
+A ViewSet class for OSTree head commits.
+
+### 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::ContentRefsApi.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.
+  repository_version: 'repository_version_example', # String | Repository Version referenced by HREF
+  repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF
+  repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF
+  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 refs
+  result = api_instance.list(opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling ContentRefsApi->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] 
+ **repository_version** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_added** | **String**| Repository Version referenced by HREF | [optional] 
+ **repository_version_removed** | **String**| Repository Version referenced by HREF | [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
+
+[**PaginatedostreeOstreeRefResponseList**](PaginatedostreeOstreeRefResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> OstreeOstreeRefResponse read(ostree_ostree_ref_href, opts)
+
+Inspect an ostree ref
+
+A ViewSet class for OSTree head commits.
+
+### 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::ContentRefsApi.new
+ostree_ostree_ref_href = 'ostree_ostree_ref_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 ref
+  result = api_instance.read(ostree_ostree_ref_href, opts)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Exception when calling ContentRefsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ostree_ostree_ref_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
+
+[**OstreeOstreeRefResponse**](OstreeOstreeRefResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/{ContentOstreeApi.md → ContentSummariesApi.md}

@@ -1,75 +1,21 @@
-# PulpOstreeClient::ContentOstreeApi
+# PulpOstreeClient::ContentSummariesApi
 
-All URIs are relative to *http://pulp*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create**](ContentOstreeApi.md#create) | **POST** /pulp/api/v3/content/ostree/ostree/ | Create an ostree content
-[**list**](ContentOstreeApi.md#list) | **GET** /pulp/api/v3/content/ostree/ostree/ | List ostree contents
-[**read**](ContentOstreeApi.md#read) | **GET** {ostree_ostree_content_href} | Inspect an ostree content
+[**list**](ContentSummariesApi.md#list) | **GET** /pulp/api/v3/content/ostree/summaries/ | List ostree summarys
+[**read**](ContentSummariesApi.md#read) | **GET** {ostree_ostree_summary_href} | Inspect an ostree summary
 
 
 
-## create
-
-> OstreeOstreeContentResponse create(ostree_ostree_content)
-
-Create an ostree content
-
-Perform bookkeeping when saving Content.  \"Artifacts\" need to be popped off and saved indpendently, as they are not actually part of the Content model.
-
-### 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::ContentOstreeApi.new
-ostree_ostree_content = PulpOstreeClient::OstreeOstreeContent.new # OstreeOstreeContent | 
-
-begin
-  #Create an ostree content
-  result = api_instance.create(ostree_ostree_content)
-  p result
-rescue PulpOstreeClient::ApiError => e
-  puts "Exception when calling ContentOstreeApi->create: #{e}"
-end
-```
-
-### Parameters
-
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ostree_ostree_content** | [**OstreeOstreeContent**](OstreeOstreeContent.md)|  | 
-
-### Return type
-
-[**OstreeOstreeContentResponse**](OstreeOstreeContentResponse.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
 
-> PaginatedostreeOstreeContentResponseList list(opts)
+> PaginatedostreeOstreeSummaryResponseList list(opts)
 
-List ostree contents
+List ostree summarys
 
-A ViewSet for OstreeContent.  Define endpoint name which will appear in the API endpoint for this content type. For example::     https://pulp.example.com/pulp/api/v3/content/ostree/units/  Also specify queryset and serializer for OstreeContent.
+A ViewSet class for OSTree repository summary files.
 
 ### Example
 
@@ -83,7 +29,7 @@ PulpOstreeClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpOstreeClient::ContentOstreeApi.new
+api_instance = PulpOstreeClient::ContentSummariesApi.new
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
@@ -96,11 +42,11 @@ opts = {
 }
 
 begin
-  #List ostree contents
+  #List ostree summarys
   result = api_instance.list(opts)
   p result
 rescue PulpOstreeClient::ApiError => e
-  puts "Exception when calling ContentOstreeApi->list: #{e}"
+  puts "Exception when calling ContentSummariesApi->list: #{e}"
 end
 ```
 
@@ -120,7 +66,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**PaginatedostreeOstreeContentResponseList**](PaginatedostreeOstreeContentResponseList.md)
+[**PaginatedostreeOstreeSummaryResponseList**](PaginatedostreeOstreeSummaryResponseList.md)
 
 ### Authorization
 
@@ -134,11 +80,11 @@ Name | Type | Description  | Notes
 
 ## read
 
-> OstreeOstreeContentResponse read(ostree_ostree_content_href, opts)
+> OstreeOstreeSummaryResponse read(ostree_ostree_summary_href, opts)
 
-Inspect an ostree content
+Inspect an ostree summary
 
-A ViewSet for OstreeContent.  Define endpoint name which will appear in the API endpoint for this content type. For example::     https://pulp.example.com/pulp/api/v3/content/ostree/units/  Also specify queryset and serializer for OstreeContent.
+A ViewSet class for OSTree repository summary files.
 
 ### Example
 
@@ -152,19 +98,19 @@ PulpOstreeClient.configure do |config|
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = PulpOstreeClient::ContentOstreeApi.new
-ostree_ostree_content_href = 'ostree_ostree_content_href_example' # String | 
+api_instance = PulpOstreeClient::ContentSummariesApi.new
+ostree_ostree_summary_href = 'ostree_ostree_summary_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 content
-  result = api_instance.read(ostree_ostree_content_href, opts)
+  #Inspect an ostree summary
+  result = api_instance.read(ostree_ostree_summary_href, opts)
   p result
 rescue PulpOstreeClient::ApiError => e
-  puts "Exception when calling ContentOstreeApi->read: #{e}"
+  puts "Exception when calling ContentSummariesApi->read: #{e}"
 end
 ```
 
@@ -173,13 +119,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ostree_ostree_content_href** | **String**|  | 
+ **ostree_ostree_summary_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
 
-[**OstreeOstreeContentResponse**](OstreeOstreeContentResponse.md)
+[**OstreeOstreeSummaryResponse**](OstreeOstreeSummaryResponse.md)
 
 ### Authorization
 

data/docs/DistributionsOstreeApi.md

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

data/docs/OstreeOstreeCommitResponse.md

@@ -0,0 +1,25 @@
+# PulpOstreeClient::OstreeOstreeCommitResponse
+
+## 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 | 
+**parent_commit** | **String** |  | [optional] 
+**checksum** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::OstreeOstreeCommitResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null,
+                                 parent_commit: null,
+                                 checksum: null)
+```
+
+

data/docs/OstreeOstreeConfigResponse.md

@@ -0,0 +1,21 @@
+# PulpOstreeClient::OstreeOstreeConfigResponse
+
+## 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 | 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::OstreeOstreeConfigResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null)
+```
+
+

data/docs/OstreeOstreeDistribution.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
 **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::OstreeOstreeDistribution.new(base_path: null,
                                  pulp_labels: null,
                                  name: null,
                                  repository: null,
-                                 publication: null)
+                                 repository_version: null)
 ```
 
 

data/docs/OstreeOstreeDistributionResponse.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **pulp_labels** | [**Object**](.md) |  | [optional] 
 **name** | **String** | A unique name. Ex, `rawhide` and `stable`. | 
 **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
 
@@ -27,7 +27,7 @@ instance = PulpOstreeClient::OstreeOstreeDistributionResponse.new(pulp_href: nul
                                  pulp_labels: null,
                                  name: null,
                                  repository: null,
-                                 publication: null)
+                                 repository_version: null)
 ```
 
 

data/docs/OstreeOstreeObjectResponse.md

@@ -0,0 +1,27 @@
+# PulpOstreeClient::OstreeOstreeObjectResponse
+
+## 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** |  | 
+**checksum** | **String** |  | 
+**typ** | **Integer** |              The type of an object. All values are described by the mapping declared at             https://lazka.github.io/pgi-docs/OSTree-1.0/enums.html#OSTree.ObjectType              | 
+
+## Code Sample
+
+```ruby
+require 'PulpOstreeClient'
+
+instance = PulpOstreeClient::OstreeOstreeObjectResponse.new(pulp_href: null,
+                                 pulp_created: null,
+                                 artifact: null,
+                                 commit: null,
+                                 checksum: null,
+                                 typ: null)
+```
+
+