pulp_ansible_client 0.16.5 → 0.17.0

data/docs/PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.md

@@ -0,0 +1,168 @@
+# PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/search/collection-versions/ | 
+[**rebuild**](PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.md#rebuild) | **POST** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/search/collection-versions/ | 
+
+
+
+## list
+
+> PaginatedCollectionVersionSearchListResponseList list(path, opts)
+
+
+
+A viewset for cross-repo searches.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.new
+path = 'path_example' # String | 
+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.
+  highest: true, # Boolean | 
+  is_deprecated: true, # Boolean | 
+  is_highest: true, # Boolean | 
+  is_signed: true, # Boolean | 
+  keywords: 'keywords_example', # String | 
+  limit: 56, # Integer | Number of results to return per page.
+  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
+  q: 'q_example', # String | 
+  repository: ['repository_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_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.
+}
+
+begin
+  result = api_instance.list(path, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**|  | 
+ **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 | [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
+
+[**PaginatedCollectionVersionSearchListResponseList**](PaginatedCollectionVersionSearchListResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rebuild
+
+> CollectionVersionSearchListResponse rebuild(path, collection_version_search_list)
+
+
+
+A viewset for cross-repo searches.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi.new
+path = 'path_example' # String | 
+collection_version_search_list = PulpAnsibleClient::CollectionVersionSearchList.new # CollectionVersionSearchList | 
+
+begin
+  result = api_instance.rebuild(path, collection_version_search_list)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleApiV3PluginAnsibleSearchCollectionVersionsApi->rebuild: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **path** | **String**|  | 
+ **collection_version_search_list** | [**CollectionVersionSearchList**](CollectionVersionSearchList.md)|  | 
+
+### Return type
+
+[**CollectionVersionSearchListResponse**](CollectionVersionSearchListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/PulpAnsibleArtifactsCollectionsV3Api.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleArtifactsCollectionsV3Api
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3Api.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3Api
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3ArtifactsCollectionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3ArtifactsCollectionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3CollectionVersionsAllApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionVersionsAllApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3CollectionsAllApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsAllApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3CollectionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3CollectionsVersionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3NamespacesApi.md

@@ -0,0 +1,154 @@
+# PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi
+
+All URIs are relative to *https://pulp*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list**](PulpAnsibleDefaultApiV3NamespacesApi.md#list) | **GET** /pulp_ansible/galaxy/default/api/v3/namespaces/ | 
+[**read**](PulpAnsibleDefaultApiV3NamespacesApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/namespaces/{name}/ | 
+
+
+
+## list
+
+> PaginatedansibleAnsibleNamespaceMetadataResponseList list(opts)
+
+
+
+Legacy v3 endpoint.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi.new
+opts = {
+  company: 'company_example', # String | Filter results where company matches value
+  company__contains: 'company__contains_example', # String | Filter results where company contains value
+  company__icontains: 'company__icontains_example', # String | Filter results where company contains value
+  company__in: ['company__in_example'], # Array<String> | Filter results where company is in a comma-separated list of values
+  company__startswith: 'company__startswith_example', # String | Filter results where company starts with value
+  limit: 56, # Integer | Number of results to return per page.
+  metadata_sha256: 'metadata_sha256_example', # String | Filter results where metadata_sha256 matches value
+  metadata_sha256__in: ['metadata_sha256__in_example'], # Array<String> | Filter results where metadata_sha256 is in a comma-separated list of values
+  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__in: ['name__in_example'], # Array<String> | Filter results where name is in a comma-separated list of values
+  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
+  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.
+}
+
+begin
+  result = api_instance.list(opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3NamespacesApi->list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **company** | **String**| Filter results where company matches value | [optional] 
+ **company__contains** | **String**| Filter results where company contains value | [optional] 
+ **company__icontains** | **String**| Filter results where company contains value | [optional] 
+ **company__in** | [**Array&lt;String&gt;**](String.md)| Filter results where company is in a comma-separated list of values | [optional] 
+ **company__startswith** | **String**| Filter results where company starts with value | [optional] 
+ **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **metadata_sha256** | **String**| Filter results where metadata_sha256 matches value | [optional] 
+ **metadata_sha256__in** | [**Array&lt;String&gt;**](String.md)| Filter results where metadata_sha256 is in a comma-separated list of values | [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__in** | [**Array&lt;String&gt;**](String.md)| Filter results where name is in a comma-separated list of values | [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 | [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
+
+[**PaginatedansibleAnsibleNamespaceMetadataResponseList**](PaginatedansibleAnsibleNamespaceMetadataResponseList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleAnsibleNamespaceMetadataResponse read(name, opts)
+
+
+
+Legacy v3 endpoint.
+
+### Example
+
+```ruby
+# load the gem
+require 'pulp_ansible_client'
+# setup authorization
+PulpAnsibleClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3NamespacesApi.new
+name = 'name_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.
+}
+
+begin
+  result = api_instance.read(name, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling PulpAnsibleDefaultApiV3NamespacesApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **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
+
+[**AnsibleAnsibleNamespaceMetadataResponse**](AnsibleAnsibleNamespaceMetadataResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.md

@@ -1,20 +1,20 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get**](PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.md#get) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/client-configuration/ | 
+[**read**](PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/plugin/ansible/client-configuration/ | 
 
 
 
-## get
+## read
 
-> ClientConfigurationResponse get
+> ClientConfigurationResponse read
 
 
 
-Get the client configs.
+Return configurations for the ansible-galaxy client.
 
 ### Example
 
@@ -31,10 +31,10 @@ end
 api_instance = PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi.new
 
 begin
-  result = api_instance.get
+  result = api_instance.read
   p result
 rescue PulpAnsibleClient::ApiError => e
-  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi->get: #{e}"
+  puts "Exception when calling PulpAnsibleDefaultApiV3PluginAnsibleClientConfigurationApi->read: #{e}"
 end
 ```
 

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllCollectionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllCollectionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllVersionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsAllVersionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsArtifactsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------

data/docs/PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi.md

@@ -1,6 +1,6 @@
 # PulpAnsibleClient::PulpAnsibleDefaultApiV3PluginAnsibleContentCollectionsIndexVersionsDocsBlobApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *https://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------