pulp_deb_client 3.5.0 → 3.5.2

data/docs/ContentGenericContentsApi.md

@@ -2,26 +2,27 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**create**](ContentGenericContentsApi.md#create) | **POST** /pulp/api/v3/content/deb/generic_contents/ | Create a generic content
-[**list**](ContentGenericContentsApi.md#list) | **GET** /pulp/api/v3/content/deb/generic_contents/ | List generic contents
-[**read**](ContentGenericContentsApi.md#read) | **GET** {deb_generic_content_href} | Inspect a generic content
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create**](ContentGenericContentsApi.md#create) | **POST** /pulp/api/v3/content/deb/generic_contents/ | Create a generic content |
+| [**list**](ContentGenericContentsApi.md#list) | **GET** /pulp/api/v3/content/deb/generic_contents/ | List generic contents |
+| [**read**](ContentGenericContentsApi.md#read) | **GET** {deb_generic_content_href} | Inspect a generic content |
+| [**set_label**](ContentGenericContentsApi.md#set_label) | **POST** {deb_generic_content_href}set_label/ | Set a label |
+| [**unset_label**](ContentGenericContentsApi.md#unset_label) | **POST** {deb_generic_content_href}unset_label/ | Unset a label |
 
 
 ## create
 
-> AsyncOperationResponse create(relative_path, opts)
+> <AsyncOperationResponse> create(relative_path, opts)
 
 Create a generic content
 
 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|
@@ -34,32 +35,51 @@ api_instance = PulpDebClient::ContentGenericContentsApi.new
 relative_path = 'relative_path_example' # String | Path where the artifact is located relative to distributions base_path
 opts = {
   repository: 'repository_example', # String | A URI of a repository the new content unit should be associated with.
+  pulp_labels: { key: 'inner_example'}, # Hash<String, String> | A dictionary of arbitrary key/value pairs used to describe a specific Content instance.
   artifact: 'artifact_example', # String | Artifact file representing the physical content
-  file: File.new('/path/to/file'), # File | An uploaded file that may be turned into the content unit.
+  file: File.new('/path/to/some/file'), # File | An uploaded file that may be turned into the content unit.
   upload: 'upload_example', # String | An uncommitted upload that may be turned into the content unit.
   file_url: 'file_url_example' # String | A url that Pulp can download and turn into the content unit.
 }
 
 begin
-  #Create a generic content
+  # Create a generic content
   result = api_instance.create(relative_path, opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentGenericContentsApi->create: #{e}"
+  puts "Error when calling ContentGenericContentsApi->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(relative_path, opts)
+
+```ruby
+begin
+  # Create a generic content
+  data, status_code, headers = api_instance.create_with_http_info(relative_path, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AsyncOperationResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->create_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **relative_path** | **String**| Path where the artifact is located relative to distributions base_path | 
- **repository** | **String**| A URI of a repository the new content unit should be associated with. | [optional] 
- **artifact** | **String**| Artifact file representing the physical content | [optional] 
- **file** | **File**| An uploaded file that may be turned into the content unit. | [optional] 
- **upload** | **String**| An uncommitted upload that may be turned into the content unit. | [optional] 
- **file_url** | **String**| A url that Pulp can download and turn into the content unit. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **relative_path** | **String** | Path where the artifact is located relative to distributions base_path |  |
+| **repository** | **String** | A URI of a repository the new content unit should be associated with. | [optional] |
+| **pulp_labels** | [**Hash&lt;String, String&gt;**](Hash.md) | A dictionary of arbitrary key/value pairs used to describe a specific Content instance. | [optional] |
+| **artifact** | **String** | Artifact file representing the physical content | [optional] |
+| **file** | **File** | An uploaded file that may be turned into the content unit. | [optional] |
+| **upload** | **String** | An uncommitted upload that may be turned into the content unit. | [optional] |
+| **file_url** | **String** | A url that Pulp can download and turn into the content unit. | [optional] |
 
 ### Return type
 
@@ -77,16 +97,16 @@ Name | Type | Description  | Notes
 
 ## list
 
-> PaginateddebGenericContentResponseList list(opts)
+> <PaginateddebGenericContentResponseList> list(opts)
 
 List generic contents
 
 GenericContent is a catch all category for storing files not covered by any other type.  Associated artifacts: Exactly one arbitrary file that does not match any other type.  This is needed to store arbitrary files for use with the verbatim publisher. If you are not using the verbatim publisher, you may ignore this type.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -99,50 +119,69 @@ api_instance = PulpDebClient::ContentGenericContentsApi.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  * `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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `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  * `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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `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
   relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
   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
   sha256: 'sha256_example', # String | Filter results where sha256 matches value
-  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 generic contents
+  # List generic contents
   result = api_instance.list(opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentGenericContentsApi->list: #{e}"
+  puts "Error when calling ContentGenericContentsApi->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(<PaginateddebGenericContentResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List generic contents
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginateddebGenericContentResponseList>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->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;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;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (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] 
- **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] 
- **relative_path** | **String**| Filter results where relative_path matches value | [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] 
- **sha256** | **String**| Filter results where sha256 matches value | [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 |
+| ---- | ---- | ----------- | ----- |
+| **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;relative_path&#x60; - Relative path * &#x60;-relative_path&#x60; - Relative path (descending) * &#x60;sha256&#x60; - Sha256 * &#x60;-sha256&#x60; - Sha256 (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] |
+| **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] |
+| **relative_path** | **String** | Filter results where relative_path matches value | [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] |
+| **sha256** | **String** | Filter results where sha256 matches value | [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
 
@@ -160,16 +199,16 @@ Name | Type | Description  | Notes
 
 ## read
 
-> DebGenericContentResponse read(deb_generic_content_href, opts)
+> <DebGenericContentResponse> read(deb_generic_content_href, opts)
 
 Inspect a generic content
 
 GenericContent is a catch all category for storing files not covered by any other type.  Associated artifacts: Exactly one arbitrary file that does not match any other type.  This is needed to store arbitrary files for use with the verbatim publisher. If you are not using the verbatim publisher, you may ignore this type.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_deb_client'
 # setup authorization
 PulpDebClient.configure do |config|
@@ -181,27 +220,44 @@ end
 api_instance = PulpDebClient::ContentGenericContentsApi.new
 deb_generic_content_href = 'deb_generic_content_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 generic content
+  # Inspect a generic content
   result = api_instance.read(deb_generic_content_href, opts)
   p result
 rescue PulpDebClient::ApiError => e
-  puts "Exception when calling ContentGenericContentsApi->read: #{e}"
+  puts "Error when calling ContentGenericContentsApi->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(<DebGenericContentResponse>, Integer, Hash)> read_with_http_info(deb_generic_content_href, opts)
 
+```ruby
+begin
+  # Inspect a generic content
+  data, status_code, headers = api_instance.read_with_http_info(deb_generic_content_href, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DebGenericContentResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->read_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **deb_generic_content_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_generic_content_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
 
@@ -216,3 +272,147 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## set_label
+
+> <SetLabelResponse> set_label(deb_generic_content_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::ContentGenericContentsApi.new
+deb_generic_content_href = 'deb_generic_content_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_generic_content_href, set_label)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->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_generic_content_href, set_label)
+
+```ruby
+begin
+  # Set a label
+  data, status_code, headers = api_instance.set_label_with_http_info(deb_generic_content_href, set_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SetLabelResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->set_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_generic_content_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_generic_content_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::ContentGenericContentsApi.new
+deb_generic_content_href = 'deb_generic_content_href_example' # String | 
+unset_label = PulpDebClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel | 
+
+begin
+  # Unset a label
+  result = api_instance.unset_label(deb_generic_content_href, unset_label)
+  p result
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->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_generic_content_href, unset_label)
+
+```ruby
+begin
+  # Unset a label
+  data, status_code, headers = api_instance.unset_label_with_http_info(deb_generic_content_href, unset_label)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnsetLabelResponse>
+rescue PulpDebClient::ApiError => e
+  puts "Error when calling ContentGenericContentsApi->unset_label_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deb_generic_content_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
+