pulp_ostree_client 2.4.5 → 2.4.7

data/docs/ContentConfigsApi.md

@@ -2,25 +2,26 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](ContentConfigsApi.md#list) | **GET** /pulp/api/v3/content/ostree/configs/ | List ostree configs
-[**read**](ContentConfigsApi.md#read) | **GET** {ostree_ostree_config_href} | Inspect an ostree config
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](ContentConfigsApi.md#list) | **GET** /pulp/api/v3/content/ostree/configs/ | List ostree configs |
+| [**read**](ContentConfigsApi.md#read) | **GET** {ostree_ostree_config_href} | Inspect an ostree config |
+| [**set_label**](ContentConfigsApi.md#set_label) | **POST** {ostree_ostree_config_href}set_label/ | Set a label |
+| [**unset_label**](ContentConfigsApi.md#unset_label) | **POST** {ostree_ostree_config_href}unset_label/ | Unset a label |
 
 
 ## list
 
-> PaginatedostreeOstreeConfigResponseList list(opts)
+> <PaginatedostreeOstreeConfigResponseList> list(opts)
 
 List ostree configs
 
 A ViewSet class for OSTree repository configurations.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ostree_client'
 # setup authorization
 PulpOstreeClient.configure do |config|
@@ -33,46 +34,65 @@ api_instance = PulpOstreeClient::ContentConfigsApi.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'], # Array<String> | Ordering  * `pk` - Pk * `-pk` - Pk (descending)
-  orphaned_for: 3.4, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
-  prn__in: ['prn__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_href__in: ['pulp_href__in_example'], # Array<String> | Multiple values may be separated by commas.
-  pulp_id__in: ['pulp_id__in_example'], # Array<String> | Multiple values may be separated by commas.
+  ordering: ['-pk'], # Array<String> | Ordering  * `pk` - Pk * `-pk` - Pk (descending)
+  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
+  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.
+  pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
   q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
   repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
   repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
   repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  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 ostree configs
+  # List ostree configs
   result = api_instance.list(opts)
   p result
 rescue PulpOstreeClient::ApiError => e
-  puts "Exception when calling ContentConfigsApi->list: #{e}"
+  puts "Error when calling ContentConfigsApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-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** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] 
- **orphaned_for** | **Float**| Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] 
- **prn__in** | [**Array&lt;String&gt;**](String.md)| Multiple values may be separated by commas. | [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_version** | **String**| Repository Version referenced by HREF/PRN | [optional] 
- **repository_version_added** | **String**| Repository Version referenced by HREF/PRN | [optional] 
- **repository_version_removed** | **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] 
+> <Array(<PaginatedostreeOstreeConfigResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List ostree configs
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedostreeOstreeConfigResponseList>
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->list_with_http_info: #{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** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [optional] |
+| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
+| **prn__in** | [**Array&lt;String&gt;**](String.md) | Multiple values may be separated by commas. | [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] |
+| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
+| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
+| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
+| **repository_version_removed** | **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
 
@@ -90,16 +110,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> OstreeOstreeConfigResponse read(ostree_ostree_config_href, opts)
+> <OstreeOstreeConfigResponse> read(ostree_ostree_config_href, opts)
 
 Inspect an ostree config
 
 A ViewSet class for OSTree repository configurations.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ostree_client'
 # setup authorization
 PulpOstreeClient.configure do |config|
@@ -111,27 +131,44 @@ end
 api_instance = PulpOstreeClient::ContentConfigsApi.new
 ostree_ostree_config_href = 'ostree_ostree_config_href_example' # String | 
 opts = {
-  fields: ['fields_example'], # Array<String> | A list of fields to include in the response.
-  exclude_fields: ['exclude_fields_example'] # Array<String> | A list of fields to exclude from the response.
+  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 an ostree config
+  # Inspect an ostree config
   result = api_instance.read(ostree_ostree_config_href, opts)
   p result
 rescue PulpOstreeClient::ApiError => e
-  puts "Exception when calling ContentConfigsApi->read: #{e}"
+  puts "Error when calling ContentConfigsApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
 
+This returns an Array which contains the response data, status code and headers.
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **ostree_ostree_config_href** | **String**|  | 
- **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] 
+> <Array(<OstreeOstreeConfigResponse>, Integer, Hash)> read_with_http_info(ostree_ostree_config_href, opts)
+
+```ruby
+begin
+  # Inspect an ostree config
+  data, status_code, headers = api_instance.read_with_http_info(ostree_ostree_config_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OstreeOstreeConfigResponse>
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ostree_ostree_config_href** | **String** |  |  |
+| **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
 
@@ -146,3 +183,147 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## set_label
+
+> <SetLabelResponse> set_label(ostree_ostree_config_href, set_label)
+
+Set a label
+
+Set a single pulp_label on the object to a specific value or null.
+
+### Examples
+
+```ruby
+require 'time'
+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::ContentConfigsApi.new
+ostree_ostree_config_href = 'ostree_ostree_config_href_example' # String | 
+set_label = PulpOstreeClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel | 
+
+begin
+  # Set a label
+  result = api_instance.set_label(ostree_ostree_config_href, set_label)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->set_label: #{e}"
+end
+```
+
+#### Using the set_label_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(ostree_ostree_config_href, set_label)
+
+```ruby
+begin
+  # Set a label
+  data, status_code, headers = api_instance.set_label_with_http_info(ostree_ostree_config_href, set_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetLabelResponse>
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->set_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ostree_ostree_config_href** | **String** |  |  |
+| **set_label** | [**SetLabel**](SetLabel.md) |  |  |
+
+### Return type
+
+[**SetLabelResponse**](SetLabelResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## unset_label
+
+> <UnsetLabelResponse> unset_label(ostree_ostree_config_href, unset_label)
+
+Unset a label
+
+Unset a single pulp_label on the object.
+
+### Examples
+
+```ruby
+require 'time'
+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::ContentConfigsApi.new
+ostree_ostree_config_href = 'ostree_ostree_config_href_example' # String | 
+unset_label = PulpOstreeClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel | 
+
+begin
+  # Unset a label
+  result = api_instance.unset_label(ostree_ostree_config_href, unset_label)
+  p result
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->unset_label: #{e}"
+end
+```
+
+#### Using the unset_label_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(ostree_ostree_config_href, unset_label)
+
+```ruby
+begin
+  # Unset a label
+  data, status_code, headers = api_instance.unset_label_with_http_info(ostree_ostree_config_href, unset_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnsetLabelResponse>
+rescue PulpOstreeClient::ApiError => e
+  puts "Error when calling ContentConfigsApi->unset_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ostree_ostree_config_href** | **String** |  |  |
+| **unset_label** | [**UnsetLabel**](UnsetLabel.md) |  |  |
+
+### Return type
+
+[**UnsetLabelResponse**](UnsetLabelResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+