AnsibleCollectionsApi.md in pulp_ansible_client-0.22.0

- old
+ new

@@ -1,15 +1,16 @@
 # PulpAnsibleClient::AnsibleCollectionsApi
 
-All URIs are relative to *http://localhost:24817*
+All URIs are relative to *http://pulp*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**add_role**](AnsibleCollectionsApi.md#add_role) | **POST** {ansible_collection_href}add_role/ | Add a role
 [**list**](AnsibleCollectionsApi.md#list) | **GET** /pulp/api/v3/ansible/collections/ | List collections
 [**list_roles**](AnsibleCollectionsApi.md#list_roles) | **GET** {ansible_collection_href}list_roles/ | List roles
 [**my_permissions**](AnsibleCollectionsApi.md#my_permissions) | **GET** {ansible_collection_href}my_permissions/ | List user permissions
+[**read**](AnsibleCollectionsApi.md#read) | **GET** {ansible_collection_href} | Inspect a collection
 [**remove_role**](AnsibleCollectionsApi.md#remove_role) | **POST** {ansible_collection_href}remove_role/ | Remove a role
 [**upload_collection**](AnsibleCollectionsApi.md#upload_collection) | **POST** /ansible/collections/ | Upload a collection
 
 
 
@@ -246,9 +247,68 @@
  **exclude_fields** | [**Array&lt;String&gt;**](String.md)| A list of fields to exclude from the response. | [optional] 
 
 ### Return type
 
 [**MyPermissionsResponse**](MyPermissionsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## read
+
+> AnsibleCollectionResponse read(ansible_collection_href, opts)
+
+Inspect a collection
+
+Viewset for Ansible Collections.
+
+### 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::AnsibleCollectionsApi.new
+ansible_collection_href = 'ansible_collection_href_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
+  #Inspect a collection
+  result = api_instance.read(ansible_collection_href, opts)
+  p result
+rescue PulpAnsibleClient::ApiError => e
+  puts "Exception when calling AnsibleCollectionsApi->read: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ansible_collection_href** | **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
+
+[**AnsibleCollectionResponse**](AnsibleCollectionResponse.md)
 
 ### Authorization
 
 [basicAuth](../README.md#basicAuth)
 