Sha256: ed136dffdaf8f22eb870d08fb996342507d765b856d69116463302a491fe1069
Contents?: true
Size: 1.95 KB
Versions: 11
Compression:
Stored size: 1.95 KB
Contents
# PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi
All URIs are relative to *https://pulp*
Method | HTTP request | Description
------------- | ------------- | -------------
[**read**](PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.md#read) | **GET** /pulp_ansible/galaxy/default/api/v3/collections/{namespace}/{name}/versions/{version}/docs-blob/ |
## read
> CollectionVersionDocsResponse read(name, namespace, version, 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::PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi.new
name = 'name_example' # String |
namespace = 'namespace_example' # String |
version = 'version_example' # String |
opts = {
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.read(name, namespace, version, opts)
p result
rescue PulpAnsibleClient::ApiError => e
puts "Exception when calling PulpAnsibleDefaultApiV3CollectionsVersionsDocsBlobApi->read: #{e}"
end
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**name** | **String**| |
**namespace** | **String**| |
**version** | **String**| |
**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
[**CollectionVersionDocsResponse**](CollectionVersionDocsResponse.md)
### Authorization
[basicAuth](../README.md#basicAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
Version data entries
11 entries across 11 versions & 1 rubygems