Sha256: fb58dab0b1db8b73c9a3dae7d042f7e1bb57bf21a9ce4a5f1023a80086a5040b
Contents?: true
Size: 1.83 KB
Versions: 15
Compression:
Stored size: 1.83 KB
Contents
# PulpAnsibleClient::PulpAnsibleApiV3PluginAnsibleClientConfigurationApi
All URIs are relative to *http://pulp*
Method | HTTP request | Description
------------- | ------------- | -------------
[**read**](PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.md#read) | **GET** /pulp_ansible/galaxy/{path}/api/v3/plugin/ansible/client-configuration/ |
## read
> ClientConfigurationResponse read(path, opts)
Return configurations for the ansible-galaxy client.
### 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::PulpAnsibleApiV3PluginAnsibleClientConfigurationApi.new
path = 'path_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(path, opts)
p result
rescue PulpAnsibleClient::ApiError => e
puts "Exception when calling PulpAnsibleApiV3PluginAnsibleClientConfigurationApi->read: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**path** | **String**| |
**fields** | [**Array<String>**](String.md)| A list of fields to include in the response. | [optional]
**exclude_fields** | [**Array<String>**](String.md)| A list of fields to exclude from the response. | [optional]
### Return type
[**ClientConfigurationResponse**](ClientConfigurationResponse.md)
### Authorization
[basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
Version data entries
15 entries across 15 versions & 1 rubygems