docs/DistributionsMavenApi.md in pulp_maven_client-0.6.0 vs docs/DistributionsMavenApi.md in pulp_maven_client-0.7.0

- old
+ new

@@ -1,16 +1,18 @@ # PulpMavenClient::DistributionsMavenApi -All URIs are relative to *https://pulp* +All URIs are relative to *http://pulp* Method | HTTP request | Description ------------- | ------------- | ------------- [**create**](DistributionsMavenApi.md#create) | **POST** /pulp/api/v3/distributions/maven/maven/ | Create a maven distribution [**delete**](DistributionsMavenApi.md#delete) | **DELETE** {maven_maven_distribution_href} | Delete a maven distribution [**list**](DistributionsMavenApi.md#list) | **GET** /pulp/api/v3/distributions/maven/maven/ | List maven distributions [**partial_update**](DistributionsMavenApi.md#partial_update) | **PATCH** {maven_maven_distribution_href} | Update a maven distribution [**read**](DistributionsMavenApi.md#read) | **GET** {maven_maven_distribution_href} | Inspect a maven distribution +[**set_label**](DistributionsMavenApi.md#set_label) | **POST** {maven_maven_distribution_href}set_label/ | Set a label +[**unset_label**](DistributionsMavenApi.md#unset_label) | **POST** {maven_maven_distribution_href}unset_label/ | Unset a label [**update**](DistributionsMavenApi.md#update) | **PUT** {maven_maven_distribution_href} | Update a maven distribution ## create @@ -147,17 +149,22 @@ base_path__in: ['base_path__in_example'], # Array<String> | Filter results where base_path is in a comma-separated list of values limit: 56, # Integer | Number of results to return per page. name: 'name_example', # String | Filter results where name matches value name__contains: 'name__contains_example', # String | Filter results where name contains value name__icontains: 'name__icontains_example', # String | Filter results where name contains value + name__iexact: 'name__iexact_example', # String | Filter results where name matches value name__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values + name__iregex: 'name__iregex_example', # String | Filter results where name matches regex value + name__istartswith: 'name__istartswith_example', # String | Filter results where name starts with value + name__regex: 'name__regex_example', # String | Filter results where name matches regex value name__startswith: 'name__startswith_example', # String | Filter results where name starts with value 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `pk` - Pk * `-pk` - Pk (descending) + 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) * `name` - Name * `-name` - Name (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `base_path` - Base path * `-base_path` - Base path (descending) * `hidden` - Hidden * `-hidden` - Hidden (descending) * `pk` - Pk * `-pk` - Pk (descending) 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. pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string + q: 'q_example', # String | repository: 'repository_example', # String | Filter results where repository matches value repository__in: ['repository__in_example'], # Array<String> | Filter results where repository is in a comma-separated list of values with_content: 'with_content_example', # String | Filter distributions based on the content served by them 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. @@ -183,18 +190,23 @@ **base_path__in** | [**Array&lt;String&gt;**](String.md)| Filter results where base_path is in a comma-separated list of values | [optional] **limit** | **Integer**| Number of results to return per page. | [optional] **name** | **String**| Filter results where name matches value | [optional] **name__contains** | **String**| Filter results where name contains value | [optional] **name__icontains** | **String**| Filter results where name contains value | [optional] + **name__iexact** | **String**| Filter results where name matches value | [optional] **name__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [optional] + **name__iregex** | **String**| Filter results where name matches regex value | [optional] + **name__istartswith** | **String**| Filter results where name starts with value | [optional] + **name__regex** | **String**| Filter results where name matches regex value | [optional] **name__startswith** | **String**| Filter results where name starts with value | [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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) | [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] - **repository** | **String**| Filter results where repository matches value | [optional] + **q** | **String**| | [optional] + **repository** | [**String**](.md)| Filter results where repository matches value | [optional] **repository__in** | [**Array&lt;String&gt;**](String.md)| Filter results where repository is in a comma-separated list of values | [optional] **with_content** | **String**| Filter distributions based on the content served by them | [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] @@ -321,9 +333,119 @@ [basicAuth](../README.md#basicAuth) ### HTTP request headers - **Content-Type**: Not defined +- **Accept**: application/json + + +## set_label + +> SetLabelResponse set_label(maven_maven_distribution_href, set_label) + +Set a label + +Set a single pulp_label on the object to a specific value or null. + +### Example + +```ruby +# load the gem +require 'pulp_maven_client' +# setup authorization +PulpMavenClient.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = PulpMavenClient::DistributionsMavenApi.new +maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String | +set_label = PulpMavenClient::SetLabel.new # SetLabel | + +begin + #Set a label + result = api_instance.set_label(maven_maven_distribution_href, set_label) + p result +rescue PulpMavenClient::ApiError => e + puts "Exception when calling DistributionsMavenApi->set_label: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **maven_maven_distribution_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(maven_maven_distribution_href, unset_label) + +Unset a label + +Unset a single pulp_label on the object. + +### Example + +```ruby +# load the gem +require 'pulp_maven_client' +# setup authorization +PulpMavenClient.configure do |config| + # Configure HTTP basic authorization: basicAuth + config.username = 'YOUR USERNAME' + config.password = 'YOUR PASSWORD' +end + +api_instance = PulpMavenClient::DistributionsMavenApi.new +maven_maven_distribution_href = 'maven_maven_distribution_href_example' # String | +unset_label = PulpMavenClient::UnsetLabel.new # UnsetLabel | + +begin + #Unset a label + result = api_instance.unset_label(maven_maven_distribution_href, unset_label) + p result +rescue PulpMavenClient::ApiError => e + puts "Exception when calling DistributionsMavenApi->unset_label: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **maven_maven_distribution_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 ## update