pulp_ansible_client 0.23.1 → 0.24.0

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md

@@ -2,25 +2,24 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ | List cross repository collection version indexs
-[**rebuild**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#rebuild) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ | 
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ | List cross repository collection version indexs |
+| [**rebuild**](PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.md#rebuild) | **POST** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/search/collection-versions/ |  |
 
 
 ## list
 
-> PaginatedCollectionVersionSearchListResponseList list(opts)
+> <PaginatedCollectionVersionSearchListResponseList> list(opts)
 
 List cross repository collection version indexs
 
 A viewset for cross-repo searches.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -33,8 +32,8 @@ api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleSearchColl
 opts = {
   dependency: 'dependency_example', # String | 
   deprecated: true, # Boolean | 
-  distribution: ['distribution_example'], # Array<String> | Filter collectionversions that are in these distrubtion ids.
-  distribution_base_path: ['distribution_base_path_example'], # Array<String> | Filter collectionversions that are in these base paths.
+  distribution: ['inner_example'], # Array<String> | Filter collectionversions that are in these distrubtion ids.
+  distribution_base_path: ['inner_example'], # Array<String> | Filter collectionversions that are in these base paths.
   highest: true, # Boolean | 
   is_deprecated: true, # Boolean | 
   is_highest: true, # Boolean | 
@@ -44,59 +43,76 @@ opts = {
   name: 'name_example', # String | 
   namespace: 'namespace_example', # String | 
   offset: 56, # Integer | The initial index from which to return the results.
-  order_by: ['order_by_example'], # Array<String> | Ordering  * `pulp_created` - by CV created * `-pulp_created` - by CV created (descending) * `namespace` - by CV namespace * `-namespace` - by CV namespace (descending) * `name` - by CV name * `-name` - by CV name (descending) * `version` - by CV version * `-version` - by CV version (descending)
+  order_by: ['-name'], # Array<String> | Ordering  * `pulp_created` - by CV created * `-pulp_created` - by CV created (descending) * `namespace` - by CV namespace * `-namespace` - by CV namespace (descending) * `name` - by CV name * `-name` - by CV name (descending) * `version` - by CV version * `-version` - by CV version (descending)
   q: 'q_example', # String | 
-  repository: ['repository_example'], # Array<String> | Filter collectionversions that are in these repository ids.
+  repository: ['inner_example'], # Array<String> | Filter collectionversions that are in these repository ids.
   repository_label: 'repository_label_example', # String | Filter labels by search string
-  repository_name: ['repository_name_example'], # Array<String> | Filter collectionversions that are in these repositories.
+  repository_name: ['inner_example'], # Array<String> | Filter collectionversions that are in these repositories.
   repository_version: 'repository_version_example', # String | 
   signed: true, # Boolean | 
   tags: 'tags_example', # String | Filter by comma separate list of tags that must all be matched
   version: 'version_example', # String | 
   version_range: 'version_range_example', # String | 
-  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 cross repository collection version indexs
+  # List cross repository collection version indexs
   result = api_instance.list(opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->list: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->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(<PaginatedCollectionVersionSearchListResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List cross repository collection version indexs
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedCollectionVersionSearchListResponseList>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **dependency** | **String**|  | [optional] 
- **deprecated** | **Boolean**|  | [optional] 
- **distribution** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these distrubtion ids. | [optional] 
- **distribution_base_path** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these base paths. | [optional] 
- **highest** | **Boolean**|  | [optional] 
- **is_deprecated** | **Boolean**|  | [optional] 
- **is_highest** | **Boolean**|  | [optional] 
- **is_signed** | **Boolean**|  | [optional] 
- **keywords** | **String**|  | [optional] 
- **limit** | **Integer**| Number of results to return per page. | [optional] 
- **name** | **String**|  | [optional] 
- **namespace** | **String**|  | [optional] 
- **offset** | **Integer**| The initial index from which to return the results. | [optional] 
- **order_by** | [**Array&lt;String&gt;**](String.md)| Ordering  * &#x60;pulp_created&#x60; - by CV created * &#x60;-pulp_created&#x60; - by CV created (descending) * &#x60;namespace&#x60; - by CV namespace * &#x60;-namespace&#x60; - by CV namespace (descending) * &#x60;name&#x60; - by CV name * &#x60;-name&#x60; - by CV name (descending) * &#x60;version&#x60; - by CV version * &#x60;-version&#x60; - by CV version (descending) | [optional] 
- **q** | **String**|  | [optional] 
- **repository** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these repository ids. | [optional] 
- **repository_label** | **String**| Filter labels by search string | [optional] 
- **repository_name** | [**Array&lt;String&gt;**](String.md)| Filter collectionversions that are in these repositories. | [optional] 
- **repository_version** | **String**|  | [optional] 
- **signed** | **Boolean**|  | [optional] 
- **tags** | **String**| Filter by comma separate list of tags that must all be matched | [optional] 
- **version** | **String**|  | [optional] 
- **version_range** | **String**|  | [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 |
+| ---- | ---- | ----------- | ----- |
+| **dependency** | **String** |  | [optional] |
+| **deprecated** | **Boolean** |  | [optional] |
+| **distribution** | [**Array&lt;String&gt;**](String.md) | Filter collectionversions that are in these distrubtion ids. | [optional] |
+| **distribution_base_path** | [**Array&lt;String&gt;**](String.md) | Filter collectionversions that are in these base paths. | [optional] |
+| **highest** | **Boolean** |  | [optional] |
+| **is_deprecated** | **Boolean** |  | [optional] |
+| **is_highest** | **Boolean** |  | [optional] |
+| **is_signed** | **Boolean** |  | [optional] |
+| **keywords** | **String** |  | [optional] |
+| **limit** | **Integer** | Number of results to return per page. | [optional] |
+| **name** | **String** |  | [optional] |
+| **namespace** | **String** |  | [optional] |
+| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
+| **order_by** | [**Array&lt;String&gt;**](String.md) | Ordering  * &#x60;pulp_created&#x60; - by CV created * &#x60;-pulp_created&#x60; - by CV created (descending) * &#x60;namespace&#x60; - by CV namespace * &#x60;-namespace&#x60; - by CV namespace (descending) * &#x60;name&#x60; - by CV name * &#x60;-name&#x60; - by CV name (descending) * &#x60;version&#x60; - by CV version * &#x60;-version&#x60; - by CV version (descending) | [optional] |
+| **q** | **String** |  | [optional] |
+| **repository** | [**Array&lt;String&gt;**](String.md) | Filter collectionversions that are in these repository ids. | [optional] |
+| **repository_label** | **String** | Filter labels by search string | [optional] |
+| **repository_name** | [**Array&lt;String&gt;**](String.md) | Filter collectionversions that are in these repositories. | [optional] |
+| **repository_version** | **String** |  | [optional] |
+| **signed** | **Boolean** |  | [optional] |
+| **tags** | **String** | Filter by comma separate list of tags that must all be matched | [optional] |
+| **version** | **String** |  | [optional] |
+| **version_range** | **String** |  | [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
 
@@ -114,16 +130,16 @@ Name | Type | Description  | Notes
 
 ## rebuild
 
-> CollectionVersionSearchListResponse rebuild(collection_version_search_list)
+> <CollectionVersionSearchListResponse> rebuild(collection_version_search_list)
 
 
 
 A viewset for cross-repo searches.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -133,22 +149,40 @@ PulpAnsibleClient.configure do |config|
 end
 
 api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi.new
-collection_version_search_list = PulpAnsibleClient::CollectionVersionSearchList.new # CollectionVersionSearchList | 
+collection_version_search_list = PulpAnsibleClient::CollectionVersionSearchList.new({repository: PulpAnsibleClient::Repository.new({name: 'name_example'}), namespace_metadata: PulpAnsibleClient::AnsibleAnsibleNamespaceMetadata.new({name: 'name_example'}), is_highest: false, is_deprecated: false, is_signed: false}) # CollectionVersionSearchList | 
 
 begin
+  
   result = api_instance.rebuild(collection_version_search_list)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->rebuild: #{e}"
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->rebuild: #{e}"
 end
 ```
 
-### Parameters
+#### Using the rebuild_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CollectionVersionSearchListResponse>, Integer, Hash)> rebuild_with_http_info(collection_version_search_list)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.rebuild_with_http_info(collection_version_search_list)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CollectionVersionSearchListResponse>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleDefaultApiV3PluginAnsibleSearchCollectionVersionsApi->rebuild_with_http_info: #{e}"
+end
+```
 
+### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **collection_version_search_list** | [**CollectionVersionSearchList**](CollectionVersionSearchList.md)|  | 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collection_version_search_list** | [**CollectionVersionSearchList**](CollectionVersionSearchList.md) |  |  |
 
 ### Return type
 

data/docs/PulpAnsibleTagsApi.md

@@ -2,24 +2,23 @@
 
 All URIs are relative to *http://localhost:24817*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](PulpAnsibleTagsApi.md#list) | **GET** /pulp/api/v3/pulp_ansible/tags/ | List tags
-
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](PulpAnsibleTagsApi.md#list) | **GET** /pulp/api/v3/pulp_ansible/tags/ | List tags |
 
 
 ## list
 
-> PaginatedTagResponseList list(opts)
+> <PaginatedTagResponseList> list(opts)
 
 List tags
 
 ViewSet for Tag models.
 
-### Example
+### Examples
 
 ```ruby
-# load the gem
+require 'time'
 require 'pulp_ansible_client'
 # setup authorization
 PulpAnsibleClient.configure do |config|
@@ -32,28 +31,45 @@ api_instance = PulpAnsibleClient::PulpAnsibleTagsApi.new
 opts = {
   limit: 56, # Integer | Number of results to return per page.
   offset: 56, # Integer | The initial index from which to return the results.
-  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 tags
+  # List tags
   result = api_instance.list(opts)
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleTagsApi->list: #{e}"
+  puts "Error when calling PulpAnsibleTagsApi->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(<PaginatedTagResponseList>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List tags
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaginatedTagResponseList>
+rescue PulpAnsibleClient::ApiError => e
+  puts "Error when calling PulpAnsibleTagsApi->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] 
- **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] |
+| **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