pulp_deb_client 3.5.0 → 3.5.2

data/docs/ContentReleaseComponentsApi.md

@@ -2,26 +2,27 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentReleaseComponentsApi.md#create) | **POST** /pulp/api/v3/content/deb/release_components/ | Create a release component
-[**list**](ContentReleaseComponentsApi.md#list) | **GET** /pulp/api/v3/content/deb/release_components/ | List release components
-[**read**](ContentReleaseComponentsApi.md#read) | **GET** {deb_release_component_href} | Inspect a release component
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentReleaseComponentsApi.md#create) | **POST** /pulp/api/v3/content/deb/release_components/ | Create a release component |
+| [**list**](ContentReleaseComponentsApi.md#list) | **GET** /pulp/api/v3/content/deb/release_components/ | List release components |
+| [**read**](ContentReleaseComponentsApi.md#read) | **GET** {deb_release_component_href} | Inspect a release component |
+| [**set_label**](ContentReleaseComponentsApi.md#set_label) | **POST** {deb_release_component_href}set_label/ | Set a label |
+| [**unset_label**](ContentReleaseComponentsApi.md#unset_label) | **POST** {deb_release_component_href}unset_label/ | Unset a label |
 
 
 ## create
 
-> AsyncOperationResponse create(deb_release_component)
+> <AsyncOperationResponse> create(deb_release_component)
 
 Create a release component
 
 Trigger an asynchronous task to create content,optionally create new repository version.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -31,23 +32,40 @@ PulpDebClient.configure do |config|
 end
 
 api_instance = PulpDebClient::ContentReleaseComponentsApi.new
-deb_release_component = PulpDebClient::DebReleaseComponent.new # DebReleaseComponent | 
+deb_release_component = PulpDebClient::DebReleaseComponent.new({component: 'component_example', distribution: 'distribution_example'}) # DebReleaseComponent | 
 
 begin
-  #Create a release component
+  # Create a release component
   result = api_instance.create(deb_release_component)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentReleaseComponentsApi->create: #{e}"
+  puts "Error when calling ContentReleaseComponentsApi->create: #{e}"
 end
 ```
 
-### Parameters
+#### 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(deb_release_component)
+
+```ruby
+begin
+  # Create a release component
+  data, status_code, headers = api_instance.create_with_http_info(deb_release_component)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **deb_release_component** | [**DebReleaseComponent**](DebReleaseComponent.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_release_component** | [**DebReleaseComponent**](DebReleaseComponent.md) |  |  |
 
 ### Return type
 
@@ -65,16 +83,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginateddebReleaseComponentResponseList list(opts)
+> <PaginateddebReleaseComponentResponseList> list(opts)
 
 List release components
 
 A ReleaseComponent represents a single APT repository component.  Associated artifacts: None; contains only metadata.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -89,50 +107,69 @@ opts = {
   distribution: 'distribution_example', # String | Filter results where distribution matches value
   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  * `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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `distribution` - Distribution * `-distribution` - Distribution (descending) * `component` - Component * `-component` - Component (descending) * `pk` - Pk * `-pk` - Pk (descending)
-  orphaned_for: 3.4, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+  ordering: ['-component'], # 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) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `distribution` - Distribution * `-distribution` - Distribution (descending) * `component` - Component * `-component` - Component (descending) * `pk` - Pk * `-pk` - Pk (descending)
+  orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
   package: 'package_example', # String |      Must be a comma-separated string: \"package_href,repository_or_repository_version_href\"     package_href: Filter results where ReleaseComponent contains Package     repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository         href (assume latest version)     
-  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.
+  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 release components
+  # List release components
   result = api_instance.list(opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentReleaseComponentsApi->list: #{e}"
+  puts "Error when calling ContentReleaseComponentsApi->list: #{e}"
 end
 ```
 
-### Parameters
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaginateddebReleaseComponentResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List release components
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginateddebReleaseComponentResponseList>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->list_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **component** | **String**| Filter results where component matches value | [optional] 
- **distribution** | **String**| Filter results where distribution matches value | [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;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;distribution&#x60; - Distribution * &#x60;-distribution&#x60; - Distribution (descending) * &#x60;component&#x60; - Component * &#x60;-component&#x60; - Component (descending) * &#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] 
- **package** | **String**|      Must be a comma-separated string: \&quot;package_href,repository_or_repository_version_href\&quot;     package_href: Filter results where ReleaseComponent contains Package     repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository         href (assume latest version)      | [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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **component** | **String** | Filter results where component matches value | [optional] |
+| **distribution** | **String** | Filter results where distribution matches value | [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;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;distribution&#x60; - Distribution * &#x60;-distribution&#x60; - Distribution (descending) * &#x60;component&#x60; - Component * &#x60;-component&#x60; - Component (descending) * &#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] |
+| **package** | **String** |      Must be a comma-separated string: \&quot;package_href,repository_or_repository_version_href\&quot;     package_href: Filter results where ReleaseComponent contains Package     repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository         href (assume latest version)      | [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
 
@@ -150,16 +187,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> DebReleaseComponentResponse read(deb_release_component_href, opts)
+> <DebReleaseComponentResponse> read(deb_release_component_href, opts)
 
 Inspect a release component
 
 A ReleaseComponent represents a single APT repository component.  Associated artifacts: None; contains only metadata.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -171,27 +208,44 @@ end
 api_instance = PulpDebClient::ContentReleaseComponentsApi.new
 deb_release_component_href = 'deb_release_component_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 a release component
+  # Inspect a release component
   result = api_instance.read(deb_release_component_href, opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentReleaseComponentsApi->read: #{e}"
+  puts "Error when calling ContentReleaseComponentsApi->read: #{e}"
 end
 ```
 
-### Parameters
+#### Using the read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DebReleaseComponentResponse>, Integer, Hash)> read_with_http_info(deb_release_component_href, opts)
 
+```ruby
+begin
+  # Inspect a release component
+  data, status_code, headers = api_instance.read_with_http_info(deb_release_component_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DebReleaseComponentResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **deb_release_component_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] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_release_component_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
 
@@ -206,3 +260,147 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## set_label
+
+> <SetLabelResponse> set_label(deb_release_component_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_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentReleaseComponentsApi.new
+deb_release_component_href = 'deb_release_component_href_example' # String | 
+set_label = PulpDebClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel | 
+
+begin
+  # Set a label
+  result = api_instance.set_label(deb_release_component_href, set_label)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->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(deb_release_component_href, set_label)
+
+```ruby
+begin
+  # Set a label
+  data, status_code, headers = api_instance.set_label_with_http_info(deb_release_component_href, set_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetLabelResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->set_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_release_component_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(deb_release_component_href, unset_label)
+
+Unset a label
+
+Unset a single pulp_label on the object.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pulp_deb_client'
+# setup authorization
+PulpDebClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpDebClient::ContentReleaseComponentsApi.new
+deb_release_component_href = 'deb_release_component_href_example' # String | 
+unset_label = PulpDebClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel | 
+
+begin
+  # Unset a label
+  result = api_instance.unset_label(deb_release_component_href, unset_label)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->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(deb_release_component_href, unset_label)
+
+```ruby
+begin
+  # Unset a label
+  data, status_code, headers = api_instance.unset_label_with_http_info(deb_release_component_href, unset_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnsetLabelResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentReleaseComponentsApi->unset_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_release_component_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
+