Sha256: 7688cebdd571455aabf5d7ab31fb28337fb88869e3707b910eebd2e8d3e3797b

Contents?: true

Size: 1.88 KB

Versions: 6

Compression:

Stored size: 1.88 KB

Contents

# PulpAnsibleClient::PulpAnsibleApiV3CollectionsAllApi

All URIs are relative to *https://pulp*

Method | HTTP request | Description
------------- | ------------- | -------------
[**list**](PulpAnsibleApiV3CollectionsAllApi.md#list) | **GET** /pulp_ansible/galaxy/{path}/api/v3/collections/all/ | 



## list

> Array<CollectionResponse> list(path, 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::PulpAnsibleApiV3CollectionsAllApi.new
path = 'path_example' # String | 
opts = {
  deprecated: true, # Boolean | 
  name: 'name_example', # String | 
  namespace: 'namespace_example', # String | 
  fields: 'fields_example', # String | A list of fields to include in the response.
  exclude_fields: 'exclude_fields_example' # 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 PulpAnsibleApiV3CollectionsAllApi->list: #{e}"
end
```

### Parameters


Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **path** | **String**|  | 
 **deprecated** | **Boolean**|  | [optional] 
 **name** | **String**|  | [optional] 
 **namespace** | **String**|  | [optional] 
 **fields** | **String**| A list of fields to include in the response. | [optional] 
 **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 

### Return type

[**Array<CollectionResponse>**](CollectionResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
pulp_ansible_client-0.13.6 docs/PulpAnsibleApiV3CollectionsAllApi.md
pulp_ansible_client-0.13.5 docs/PulpAnsibleApiV3CollectionsAllApi.md
pulp_ansible_client-0.13.4 docs/PulpAnsibleApiV3CollectionsAllApi.md
pulp_ansible_client-0.13.2 docs/PulpAnsibleApiV3CollectionsAllApi.md
pulp_ansible_client-0.13.1 docs/PulpAnsibleApiV3CollectionsAllApi.md
pulp_ansible_client-0.13.0 docs/PulpAnsibleApiV3CollectionsAllApi.md